doc: update readme

Signed-off-by: Ganeshdip Dumbare <[email protected]>

LICENSE

@@ -0,0 +1,19 @@
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -4,31 +4,43 @@
 <img src="https://uploads-ssl.webflow.com/62dfa8e3960a6e2b47dc7fae/62fdf9cef684e6f16158b094_MARQO%20LOGO-UPDATED-GREEN.svg" width="25%" height="25%">
 </p>
 
-## marqo-go (Unofficial Go client)
+<h1 align="center">marqo-go (Unofficial Go Client)</h1>
 
+<p align="center">
 Marqo is more than a vector database, it's an end-to-end vector search engine for both text and images. Vector generation, storage and retrieval are handled out of the box through a single API. No need to bring your own embeddings.
+</p>
+
+## Features
 
-The Go client(Unofficial) allows you to connect to Marqo in less than 3 lines.
+- Easy connection to Marqo with minimal setup
+- Index creation and management
+- Document upsertion and retrieval
+- Advanced search capabilities
+- Index statistics and health monitoring
 
-## Getting started
+## Getting Started
 
-1. Marqo requires docker. To install Docker go to the [Docker Official website](https://docs.docker.com/get-docker/). Ensure that docker has at least 8GB memory and 50GB storage.
+### Prerequisites
 
-2. Use docker to run Marqo for Mac users:
+- [Docker](https://docs.docker.com/get-docker/) (Ensure that Docker has at least 8GB memory and 50GB storage)
 
-```bash
+### Installation
+
+1. **Run Marqo using Docker** (for Mac users):
+    ```bash
 ## will start marqo-os and marqo service mentioned in docker compose.
 
 docker compose up -d
 ```
 
-3. Get the Marqo Go client and start using it in your program:
-
-```bash
+2. **Get the Marqo Go client**:
+    ```bash
 go get github.com/ganeshdipdumbare/marqo-go@latest
 ```
 
-4. Start indexing and searching.
+### Usage
+
+#### Example
 
 ```Golang
 package main
@@ -187,5 +199,18 @@ func main() {
 
 ## Improvements
 
-- Add UT for all the APIs.
-- Add end to end examples for search.
+- Add unit tests for all the APIs.
+- Add end-to-end examples for search.
+
+## Contributing
+
+Contributions are welcome! Please open an issue or submit a pull request for any improvements or bug fixes.
+
+## License
+
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
+
+## Acknowledgements
+
+- [Marqo](https://marqo.ai) for providing the vector search engine.
+- [Go](https://golang.org) for the programming language.

doc.go

@@ -58,5 +58,9 @@ The simplest way to use Marqo is to create a new client and use its methods to i
 	}
 
 For a full guide visit https://github.com/ganeshdipdumbare/marqo-go
+
+# License
+
+This project is licensed under the MIT License - see the LICENSE file for details.
 */
 package marqo