Update README.md

Author: deadbits

README.md

@@ -1,2 +1,74 @@
 # vector-embedding-api
-Flask API for generating text embeddings using OpenAI or sentence_transformers
+Flask server that allows users to generate text embeddings using OpenAI's "text-embedding-ada-002" model or the Sentence Transformers library. Text embeddings are dense vector representations of textual data that capture semantic information, making them useful for various natural language processing tasks.
+
+## Features 🎯
+* POST endpoint access to text embedding models
+  * sentence_transformers
+  * OpenAI text-embedding-ada-002 
+* Easy setup with configuration file
+* Simple integration with other applications
+
+### Installation 💻
+To run this Flask server locally, follow the steps below:
+
+**Clone the repository:** 📦
+```bash
+git clone https://github.com/your-username/text-embeddings-server.git
+cd text-embeddings-server
+```
+
+**Set up a virtual environment (optional but recommended):** 🐍
+```bash
+python3 -m venv venv
+source venv/bin/activate
+```
+
+**Install the required dependencies:** 🛠️
+```bash
+pip install -r requirements.txt
+```
+
+
+### Usage
+Before running the server, make sure you have obtained an API key from OpenAI to use their "text-embedding-ada-002" model. Additionally, you need to specify the Sentence Transformers model you want to use in the server.conf file.
+
+**Modify the server.conf configuration file:** ⚙️
+```ini
+[main]
+openai_api_key = YOUR_OPENAI_API_KEY
+sent_transformers_model = YOUR_SENTENCE_TRANSFORMERS_MODEL_NAME
+```
+
+**Start the Flask server:** 🚀
+```
+python server.py
+```
+
+The server should now be running on http://127.0.0.1:5000/.
+
+
+### API Endpoints 🌐
+The server provides the following endpoint:
+
+#### POST /submit
+Submit text to be converted to embeddings.
+The default is to use the sentence transformers model.
+Setting the `ada` field to True will use the OpenAI model
+
+
+**Example Request:**
+```bash
+curl -X POST -H "Content-Type: application/json" -d '{"text": "This is an example text.", "ada": true}' http://127.0.0.1:5000/submit
+```
+
+**Example Response:**
+
+```json
+{
+    "embedding": [0.123, 0.456, ..., 0.789],
+    "status": "success"
+}
+```
+
+### Error Handling ⚠️
+The server responds with appropriate error messages if there are any issues with the request or generating embeddings.