Readme updates #9
Conversation
Merge pull request #7 from Couchbase-Ecosystem/main
README.md
Outdated
|
|
||
| The **Couchbase-Streamlit Connector** provides a seamless way to integrate Couchbase with Streamlit applications. It simplifies database operations, allowing developers to interact with Couchbase clusters directly within Streamlit without requiring extensive SDK knowledge. | ||
|
|
||
| With this connector, developers can efficiently perform CRUD (Create, Read, Update, Delete) operations, execute N1QL (SQL++) queries, and dynamically manage Couchbase collections, scopes, and buckets—all within a Streamlit app. This enables rapid prototyping and interactive data visualization while leveraging Couchbase’s powerful database capabilities. |
There was a problem hiding this comment.
execute SQL++ (formerly N1QL) queries
There was a problem hiding this comment.
Changed all mentions of N1QL to SQL++
README.md
Outdated
| With this connector, developers can efficiently perform CRUD (Create, Read, Update, Delete) operations, execute N1QL (SQL++) queries, and dynamically manage Couchbase collections, scopes, and buckets—all within a Streamlit app. This enables rapid prototyping and interactive data visualization while leveraging Couchbase’s powerful database capabilities. | ||
|
|
||
| **Key Benefits** | ||
| - **Simplified Database Access**: Eliminates the need for complex SDK implementations. |
There was a problem hiding this comment.
Eliminates the need for separate SDK implementations.
We don't want to make the SDK implementation complex :)
There was a problem hiding this comment.
🫣 oops. Fixed the language here and made it 'seperate SDK implimentations'
README.md
Outdated
| **Key Benefits** | ||
| - **Simplified Database Access**: Eliminates the need for complex SDK implementations. | ||
| - **Streamlit-Native Integration**: Designed to work seamlessly with `st.connection()`. | ||
| - **Flexible Querying**: Supports both key-value operations and SQL-like queries using N1QL. |
README.md
Outdated
| pip install plotly geopy numpy | ||
| streamlit run src/Demo.py | ||
| ``` | ||
| Or access the hosted version: [Demo App](https://couchbase-connector-demo-app.streamlit.app/) | ||
|
|
||
| ## Prerequisites | ||
| ### System Requirements |
There was a problem hiding this comment.
Make it generic as Couchbase Server after you have verified it. Mention that the free tier of Capella is the easiest way to get started with using Couchbase with Streamlit.
There was a problem hiding this comment.
Updated the Prereq (across all 3 readmes) to mention Couchbase Server compatibility as well
README.md
Outdated
| ## Contributing | ||
| We welcome contributions to improve this project! Follow the guidelines below to ensure a smooth development process. | ||
|
|
||
| ### Setting Up the Development Environment |
There was a problem hiding this comment.
While forking the clone URL will change to the user's Github account.
Might be better to link to the Github PR workflow docs like https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request
Add only the instructions to run the code for development that you have.
There was a problem hiding this comment.
I have added the link to the PR workflow. Not sure what to add to run the development code. Should I mention the tutorials for that? Also, should I remove the Reporting Issues sub-section?
README.md
Outdated
|
|
||
| Here are some helpful resources for working with Couchbase and Streamlit: | ||
| ## Understanding `BaseConnection` |
There was a problem hiding this comment.
This section is not required as this is more in the Streamlit domain & not directly relevant for users of this integration. It is mainly relevant for developers & maintainers.
There was a problem hiding this comment.
Removed the section and just added some slight relevant concepts like abstract class in the CouchbaseConnector section in form of a few lines.
This PR updates the README to provide clearer documentation and improve developer onboarding. The following enhancements have been made:
Changes: