Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

README.md with minor improvement #6

Merged
merged 2 commits into from
Oct 22, 2024
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
41 changes: 18 additions & 23 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,33 +1,28 @@
# Quarkus Jdbc Singlestore
# Quarkus JDBC Singlestore extension
Hemantkumar-Chigadani marked this conversation as resolved.
Show resolved Hide resolved

<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
[![All Contributors](https://img.shields.io/badge/all_contributors-2-orange.svg?style=flat-square)](#contributors-)
[![All Contributors](https://img.shields.io/badge/all_contributors-1-orange.svg?style=flat-square)](#contributors-)
<!-- ALL-CONTRIBUTORS-BADGE:END -->
[![Build](https://github.com/quarkiverse/quarkus-jdbc-singlestore/workflows/Build/badge.svg)](https://github.com/quarkiverse/quarkus-jdbc-singlestore/actions?query=workflow%3ABuild)
[![Maven Central](https://img.shields.io/maven-central/v/io.quarkiverse.jdbc/quarkus-jdbc-singlestore.svg?label=Maven%20Central&style=flat-square)](https://search.maven.org/artifact/io.quarkiverse.jdbc/quarkus-jdbc-singlestore)
[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg?style=flat-square)](https://opensource.org/licenses/Apache-2.0)

[![Version](https://img.shields.io/maven-central/v/io.quarkiverse.jdbc-singlestore/quarkus-jdbc-singlestore?logo=apache-maven&style=flat-square)](https://central.sonatype.com/artifact/io.quarkiverse.jdbc-singlestore/quarkus-jdbc-singlestore-parent)

## Welcome to Quarkiverse!

Congratulations and thank you for creating a new Quarkus extension project in Quarkiverse!

Feel free to replace this content with the proper description of your new project and necessary instructions how to use and contribute to it.

You can find the basic info, Quarkiverse policies and conventions in [the Quarkiverse wiki](https://github.com/quarkiverse/quarkiverse/wiki).

In case you are creating a Quarkus extension project for the first time, please follow [Building My First Extension](https://quarkus.io/guides/building-my-first-extension) guide.

Other useful articles related to Quarkus extension development can be found under the [Writing Extensions](https://quarkus.io/guides/#writing-extensions) guide category on the [Quarkus.io](https://quarkus.io) website.

Thanks again, good luck and have fun!

## Documentation
Quarkus Jdbc Singlestore is a Quarkus extension for the Singlestore jdbc driver.For more information about
the Singlestore, please refer [Singlestore](https://www.singlestore.com/)

The documentation for this extension should be maintained as part of this repository and it is stored in the `docs/` directory.
## Getting Started
Add the following dependency in your pom.xml to get started,

The layout should follow the [Antora's Standard File and Directory Set](https://docs.antora.org/antora/2.3/standard-directories/).
```xml
<dependency>
<groupId>io.quarkiverse.jdbc</groupId>
<artifactId>quarkus-jdb-singlestore</artifactId>
</dependency>
```

Once the docs are ready to be published, please open a PR including this repository in the [Quarkiverse Docs Antora playbook](https://github.com/quarkiverse/quarkiverse-docs/blob/main/antora-playbook.yml#L7). See an example [here](https://github.com/quarkiverse/quarkiverse-docs/pull/1)
## User Documentation

Your documentation will then be published to the <https://docs.quarkiverse.io/> website.
https://docs.quarkiverse.io/quarkus-jdbc-singlestoredev/index.html

## Contributors ✨

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ public String getValue(final String propertyName) {
}

if (isBuildTime) {
return "${sqlite.url}";
return "${singlestore.url}";
}

return super.getValue(propertyName);
Expand Down