From 4ce22134e2387f1e203e8b048b9175779583a2d1 Mon Sep 17 00:00:00 2001 From: Rockerz <64583161+rajveer43@users.noreply.github.com> Date: Wed, 11 Oct 2023 10:03:41 +0000 Subject: [PATCH] Add readme.md --- README.md | 74 ++++++++++++++++++------------------------------------- 1 file changed, 24 insertions(+), 50 deletions(-) diff --git a/README.md b/README.md index 734fbe8..7f6588f 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,3 @@ -

Logo @@ -7,7 +6,7 @@

Bhagavad Gita API

- Code for the BhagavadGita.io API, which is an app built for Gita readers by Gita readers. + The Bhagavad Gita API is a tool created by Gita enthusiasts for Gita enthusiasts. It provides access to the content of the Bhagavad Gita for developers to integrate into their applications.

GitHub issues @@ -23,103 +22,79 @@ ## Usage -The Bhagavad Gita API allows any developer to use content from Gita in their apps. -This API is built with FastAPI which is based on (and fully compatible with) the open standards for APIs: OpenAPI (previously known as Swagger) and JSON Schema. +The Bhagavad Gita API allows any developer to incorporate Gita content into their applications. This API is powered by FastAPI, which adheres to open standards for APIs such as OpenAPI (formerly known as Swagger) and JSON Schema. -Documentation for this API is availaible in two interactive formats: +You can access the API documentation in two interactive formats: - [Swagger UI](https://api.bhagavadgita.io/docs) - [Redoc](https://api.bhagavadgita.io/redoc) -If you are interested in using this API for your application, please -register an account at -[RapidAPI](https://rapidapi.com/bhagavad-gita-bhagavad-gita-default/api/bhagavad-gita3) -where you'll get both the credentials as well as sample code in your language of -choice. The API is 100% FREE to use. +If you're interested in using this API for your application, please register an account at [RapidAPI](https://rapidapi.com/bhagavad-gita-bhagavad-gita-default/api/bhagavad-gita3). You'll get both the necessary credentials and sample code in your preferred programming language. The API is completely free to use. ## Projects -Here is a list of interesting projects using this API. +Here is a list of interesting projects that utilize this API. - [BhagavadGita.io](https://bhagavadgita.io) - [Android App](https://play.google.com/store/apps/details?id=com.hanuman.bhagavadgita) -Have you build something with this API ? Open a "Show and tell" discussion. The maintainers will feature your project on the README if they find it interesting. +Have you built something with this API? Feel free to start a "Show and tell" discussion. The maintainers may feature your project on the README if they find it intriguing. ## Self Hosting - -The official API is free to use for all. -But If you wish you can self host anywhere you want. +The official API is open for all to use. However, if you prefer, you can self-host it wherever you like. -If you want to deploy your own instance,You can deploy -the API server on your system or VPS. +To deploy your own instance of the API server, you have two options: -- Using [`pipx`](https://pypa.github.io/pipx/installation/) - > **Note** If you dont have `pipx`, just `pip install pipx` +1. Using [`pipx`](https://pypa.github.io/pipx/installation/): + > **Note**: If you don't have `pipx`, simply install it with `pip install pipx`. ```shell pipx run bhagavad-gita-api ``` -- Or using [`docker`](https://www.docker.com/) +2. Or using [`docker`](https://www.docker.com/): ```shell docker run -it -p 8081:8081 --env-file=.env bhagavadgita/bhagavad-gita-api ``` - -Now open http://localhost:8081/docs to see docs. -To stop the server press Ctrl + C on your keyboard. - - -By default an in-memory SQLite database is used. -But you configure to use any SQL database of your choice. -The official version uses PostgreSQL. +Now, open http://localhost:8081/docs in your web browser to access the API documentation. To stop the server, press Ctrl + C on your keyboard. -Looking to deploy on a cloud platform ? -We have detailed docs to deploy to the following platforms: +By default, the API uses an in-memory SQLite database, but you can configure it to use any SQL database of your choice. The official version employs PostgreSQL. +If you're looking to deploy on a cloud platform, we have detailed documentation for deployment on the following platforms: - [Heroku](https://github.com/gita/bhagavad-gita-api/wiki/Heroku) - [Deta](https://github.com/gita/bhagavad-gita-api/wiki/Deta) - [Digital Ocean](https://github.com/gita/bhagavad-gita-api/wiki/Digial-Ocean) ## Configuration -Here is the list of supported environment variables. +Here is the list of supported environment variables: - | Name | Description | Default | | ------------------------- | ------------------------------------- | ----------- | | `TESTER_API_KEY` | The API key for testing. | `None` | -| `SQLALCHEMY_DATABASE_URI` | The DSN for your database connection. | `sqlite://` (in memory SQLite db)| - +| `SQLALCHEMY_DATABASE_URI` | The Data Source Name (DSN) for your database connection. | `sqlite://` (in-memory SQLite database) | -If you want to configure your deployment even more, -then please take a look at module [`config.py`](bhagavad_gita_api/config.py). +If you want to configure your deployment further, please refer to the [`config.py`](bhagavad_gita_api/config.py) module. -To set the environment variables, you may simply use a `.env` file where you -specify the values in the format of `KEY=VALUE`. +To set the environment variables, you can use a `.env` file where you specify the values in the format of `KEY=VALUE`. ## Development -Feel free to use the [issue tracker](https://github.com/gita/bhagavad-gita-api/issues) -for bugs and feature requests. +Feel free to use the [issue tracker](https://github.com/gita/bhagavad-gita-api/issues) for reporting bugs and suggesting new features. -Looking to contribute code ? PRs are most welcome! -To get started with developing this API, please read the [contributing guide](.github/CONTRIBUTING.md). +If you want to contribute code, pull requests are more than welcome! To get started with developing for this API, please read the [contributing guide](.github/CONTRIBUTING.md). ## Community -Join the [Discord chat server](https://discord.gg/gX8dstApZX) and -hang out with others in the community. +Join the [Discord chat server](https://discord.gg/gX8dstApZX) to interact with others in the community. -You can also use [GitHub Discussions](https://github.com/gita/bhagavad-gita-api/discussions) -to ask questions or tell us about -projects you have built using this API. +You can also use [GitHub Discussions](https://github.com/gita/bhagavad-gita-api/discussions) to ask questions or showcase projects you've built using this API. ## Contributors ✨ -Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)): +A big thank you to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)): @@ -141,5 +116,4 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d -This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) -specification. Contributions of any kind welcome! +This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. We welcome contributions of all kinds!