Update README.md

README.md

@@ -10,4 +10,94 @@ language:
 metrics:
 - accuracy
 pipeline_tag: table-question-answering
----
+---
+
+# QueryX
+
+Introducing [QueryX](https://tuito.fr/query-x/), the most efficient [Text2SQL query generation free platform](https://app.queryx.eu/#/login)!
+
+## Why QueryX?
+🎯 Improve Query Accuracy through NL prompts vs SQL
+🎯 Faster learning curve with no SQL training, faster onboarding
+🎯 Improve user satisfaction thanks to a more intuitive and accessible interface
+🎯 Extent user adoption by removing IT constraints and democratizing data access
+🎯 Reduce IT support needs and free tech resources for more relevant tasks
+
+Get ready to revolutionize your database interactions! With our amazing extractor script, QueryX doesn't need direct access to your database. Simply use the script to generate a JSON file containing all your table and column names. From there, ask your database anything using natural language – no SQL knowledge required! QueryX will transform your questions into precise SQL queries effortlessly.
+
+But wait, there's more! Connect your database link to our configuration, and watch as your queries are applied directly, providing you with instant, interactive responses. Say goodbye to the complexities of database querying and hello to seamless, intuitive interactions!
+
+For more details, please visit the [project page](https://tuito.fr/query-x/) and the Youtube video:
+
+<a href="https://www.youtube.com/watch?v=K7IU2qlmKPo" target="_blank">
+<img src="https://upload.wikimedia.org/wikipedia/commons/b/b8/YouTube_Logo_2017.svg" alt="YouTube video" style="width:30px;height:30px;">
+</a>
+
+## Want to try it?
+
+### Google Colab (for Python)
+
+- [![Open in Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/drive/1YCuDL65cJJra991NlftCxspdeNI8QQ6n?usp=sharing)
+
+### Try it on CodePen (for JavaScript)
+
+- [![Try it on CodePen for JavaScript](https://img.shields.io/badge/Try%20it%20on-CodePen-orange)](https://codepen.io/Tuito-Intuito/pen/yLWmwLB)
+
+## Get your QueryX API Key
+
+If you don't have a QueryX account, please [create a new one](https://app.queryx.eu/#/login).
+
+Your API Key is under [My API key section of the Profile page](https://app.queryx.eu/#/profil#ppage-api-key).
+
+## Code example
+
+QueryX provides Python and JavaScript client examples that can be found in the following [Github](https://github.com/Tuito-dev/queryx-client-example/tree/main) project.
+
+## Example datasets
+
+You can try first QueryX in the given two sample database:
+
+- Formula 1 database
+- Student club database
+
+## Usage
+
+### Use our interactive QueryX Chat
+
+1. Go to: https://app.queryx.eu/#/login
+2. Create an account
+3. You can either use:
+- Our "Student Club" dataset example.
+- Upload our extractor script in QueryGeneration mode.
+- Use a connected mode, by giving the link to access your database to apply the generated queries and get the results.
+
+### API mode
+
+1. Clone the repository:
+```bash
+git clone https://github.com/Tuito-dev/queryx-client-example.git
+cd queryx-client-example
+```
+
+2. Navigate to the desired example subfolder:
+```bash
+cd python-examples # For Python
+# or
+cd javascript-examples # For JavaScript
+```
+
+3. Follow the specific instructions in the subfolder's README.
+
+## API Documentation
+
+For detailed API documentation, refer to the [Api Documentation page](https://app.queryx.eu/#/api-docs)
+
+## Contributing
+
+Contributions are welcome! Please feel free to [open issues](https://github.com/Tuito-dev/queryx-client-example/issues), and [disscussions](https://github.com/Tuito-dev/queryx-client-example/discussions) or give your feedbacks from [Contact us page](https://app.queryx.eu/#/contact)
+
+## License
+
+This project is licensed under the [MIT License](https://github.com/Tuito-dev/queryx-client-example/tree/main?tab=MIT-1-ov-file).
+
+**Keywords**: queryx, api, python, javascript, nodejs, json, examples, backend, openapi, tuito, natural language to sql, sql queries, ai, artificial intelligence, query translation, data querying, sql generation, text2sql, speech2sql, SQL copilot, SQL coder