docs: readme

Author: heyjorgedev

README.md

@@ -4,23 +4,98 @@
 [![Tests](https://img.shields.io/github/actions/workflow/status/upstash/vector/run-tests.yml?branch=main&label=tests&style=flat-square)](https://github.com/upstash/vector/actions/workflows/run-tests.yml)
 [![Total Downloads](https://img.shields.io/packagist/dt/upstash/vector.svg?style=flat-square)](https://packagist.org/packages/upstash/vector)
 
-This is where your description should go. Try and limit it to a paragraph or two. Consider adding a small example.
-
-## Installation
+## Quick Start
+### Installation
 
 You can install the package via composer:
 
 ```bash
 composer require upstash/vector
 ```
 
-## Usage
+### Create Index
+
+Create a new index on [Upstash](https://console.upstash.com/vector)
+
+### Basic Usage
 
 ```php
-$index = new Upstash\Vector\Index::fromEnv();
-$index->getInfo();
+use Upstash\Vector\Index;
+
+// Initialize the index
+$index = new Index(
+    url: '<UPSTASH_VECTOR_REST_URL>',
+    token: '<UPSTASH_VECTOR_REST_TOKEN>',
+);
+
+// or just to use the environment variables
+$index = Index::fromEnv();
+
+// Upsert to dense index
+use Upstash\Vector\VectorUpsert;
+
+$index->upsert(new VectorUpsert(
+    id: 'upstash-rocks',
+    vector: [
+        0.13, 0.87, ... // dense embedding
+    ],
+    metadata: [
+        'title' => 'Lord of The Rings',
+        'genre' => 'fantasy',
+        'category' => 'classic',
+    ],
+));
+
+// Upsert data as plain text.
+use Upstash\Vector\DataUpsert;
+
+$index->upsertData(new DataUpsert(
+    id: 'tokyo',
+    data: 'Tokyo is the capital of Japan.',
+));
+
+// Query Vector Data
+use Upstash\Vector\VectorQuery;
+
+$result = $index->query(new VectorQuery(
+    vector: [0.13, 0.87, ...], // dense embedding
+    includeVectors: true,
+    includeMetadata: true,
+    topK: 1,
+));
+
+
+// Query with your data
+use Upstash\Vector\DataQuery;
+
+$result = $index->queryData(new DataQuery(
+    data: 'What is the capital of Japan?',
+    topK: 1,
+));
 ```
 
+## Namespaces
+Upstash Vector allows you to partition a single index into multiple isolated namespaces. Each namespace functions as a self-contained subset of the index, in which read and write requests are only limited to one namespace. To learn more about it, see Namespaces
+
+### Example
+```php
+use Upstash\Vector\Index;
+
+$index = Index::fromEnv();
+
+$namespace = $index->namespace('books');
+
+// Upsert to namespace
+$namespace->upsert(new VectorUpsert(
+    id: 'lord-of-the-rings',
+    vector: [0.13, 0.87, ...],
+    metadata: [
+        'title' => 'Lord of The Rings',
+        'genre' => 'fantasy',
+        'category' => 'classic',
+    ],
+));
+```
 ## Testing
 
 ```bash
@@ -30,12 +105,3 @@ composer test
 ## Changelog
 
 Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.
-
-## Credits
-
-- [Jorge Lapa](https://github.com/heyjorgedev)
-- [All Contributors](../../contributors)
-
-## License
-
-The MIT License (MIT). Please see [License File](LICENSE.md) for more information.