Add LICENSE, package.json, CHANGELOG, and enhance documentation
- Add MIT License - Add package.json with OpenClaw skill metadata - Explicitly declares NO required environment variables (fully local) - Documents data storage path: ~/.openclaw/data/rag/ - Includes installation steps and available scripts - Add CHANGELOG.md with version history (v1.0.0) - Update README.md to: - Clarify no API keys required (fully local system) - Add documentation files section - Reference CHANGELOG, LICENSE, package.json - Addresses security scanner best practices for transparency
This commit is contained in:
18
README.md
18
README.md
@@ -16,11 +16,18 @@ Full-featured Retrieval-Augmented Generation (RAG) system for OpenClaw - search
|
||||
### Installation
|
||||
|
||||
```bash
|
||||
# No external dependencies - just Python 3
|
||||
# Install Python dependency
|
||||
cd ~/.openclaw/workspace/rag
|
||||
python3 -m pip install --user chromadb
|
||||
```
|
||||
|
||||
**No API keys required** - This system is fully local:
|
||||
- Embeddings: all-MiniLM-L6-v2 (downloaded once, 79MB)
|
||||
- Vector store: ChromaDB (persistent disk storage)
|
||||
- Data location: `~/.openclaw/data/rag/` (auto-created)
|
||||
|
||||
All operations run offline with no external dependencies besides the initial ChromaDB download.
|
||||
|
||||
### Index Your Data
|
||||
|
||||
```bash
|
||||
@@ -311,10 +318,17 @@ MIT License - Free to use and modify
|
||||
|
||||
Contributions welcome! Areas for improvement:
|
||||
- API documentation indexing from external URLs
|
||||
- Automated re-indexing cron job
|
||||
- File system watch for automatic re-indexing
|
||||
- Better chunking strategies for long documents
|
||||
- Integration with external vector stores (Pinecone, Weaviate)
|
||||
|
||||
## Documentation Files
|
||||
|
||||
- **CHANGELOG.md** - Version history and changes
|
||||
- **SKILL.md** - OpenClaw skill integration guide
|
||||
- **package.json** - Skill metadata (no credentials required)
|
||||
- **LICENSE** - MIT License
|
||||
|
||||
## Author
|
||||
|
||||
Nova AI Assistant for William Mantly (Theta42)
|
||||
|
||||
Reference in New Issue
Block a user