From 8fd60ebf69981f299adb27166b5987f9b1416b52 Mon Sep 17 00:00:00 2001
From: alikahwaji <19885590+alikahwaji@users.noreply.github.com>
Date: Sat, 17 May 2025 15:24:39 +1200
Subject: [PATCH] docs: expand project README

---
 README.md | 63 ++++++++++++++++++++++++++++++++++++++++++++++++++++++-
 1 file changed, 62 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index a020894..88b604b 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,62 @@
-# SynapseStack
\ No newline at end of file
+# SynapseStack
+
+SynapseStack is a lightweight framework for building retrieval-augmented generation (RAG) services. It aims to simplify data ingestion, embedding, querying, and serverless deployment for LLM-powered applications.
+
+## Objectives
+
+- Provide an easy-to-use toolkit for RAG pipelines.
+- Support serverless export with minimal configuration.
+- Encourage architectural experimentation via ADRs.
+
+## Prerequisites
+
+- [Node.js](https://nodejs.org/) 18 or higher
+- npm (bundled with Node.js) or Yarn
+
+```bash
+node --version
+```
+
+## Installation
+
+Clone the repository and install dependencies:
+
+```bash
+git clone https://github.com/yourorg/SynapseStack.git
+cd SynapseStack
+npm install
+```
+
+## Basic Usage
+
+### rag-cli
+
+Use the command line interface to manage data and run queries locally:
+
+```bash
+npx rag-cli ingest ./data
+npx rag-cli query "What is SynapseStack?"
+```
+
+### Serverless export
+
+Build a deployable package for AWS Lambda:
+
+```bash
+npx rag-cli export --provider lambda --output dist
+```
+
+## Contributing
+
+Contributions are welcome! Please open issues to discuss features or fixes, then submit a pull request from your fork.
+
+1. Fork this repository.
+2. Create a feature branch.
+3. Commit your changes and open a pull request.
+
+Documentation lives in the `docs/` directory, and Architecture Decision Records can be found in `docs/adr/`.
+
+## License
+
+Released under the [Apache 2.0](LICENSE) license.
+