Update README.md and added LICENSE.md

Author: barrulus

LICENSE.md

@@ -0,0 +1,21 @@
+# MIT License
+
+Copyright (c) 2025 barrulus
+
+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

@@ -50,7 +50,7 @@ Edit `.env` to configure your setup:
 ```bash
 # Ollama Configuration
 OLLAMA_HOST=http://localhost:11434
-OLLAMA_MODEL=dolphincoder:15b
+OLLAMA_MODEL=qwen3:8b
 OLLAMA_EMBEDDING_MODEL=nomic-embed-text:latest
 
 # Embedding Configuration  
@@ -167,7 +167,7 @@ python ask.py my_queries.md
 | Variable | Description | Default |
 |----------|-------------|---------|
 | `OLLAMA_HOST` | Ollama server URL | `http://localhost:11434` |
-| `OLLAMA_MODEL` | LLM model for responses | `dolphincoder:15b` |
+| `OLLAMA_MODEL` | LLM model for responses | `qwen3:8b` |
 | `OLLAMA_EMBEDDING_MODEL` | Ollama embedding model | `nomic-embed-text:latest` |
 | `EMBEDDING_SERVER` | Remote embedding server URL | `http://localhost:5000` |
 | `EMBEDDING_MODEL` | Embedding model name | `nomic-ai/nomic-embed-text-v1.5` |
@@ -184,7 +184,7 @@ python ask.py my_queries.md
 #### Indexing (`index.py`)
 
 ```bash
-python index.py <repository> [options]
+python index.py /path/to/files/ [options]
 
 Options:
   --local-embeddings     Use local SentenceTransformer (default)
@@ -293,16 +293,16 @@ python embedding_server.py \
   --batch-size 64
 ```
 
-### Multiple Repositories
+### Multiple Folders
 
-Index multiple repositories to the same database:
+Index multiple folders to the same database:
 
 ```bash
-# Index first repo
-python index.py /path/to/logs1 --chroma-path ./shared_db
+# Index first folder
+python index.py /path/to/files1 --chroma-path ./shared_db
 
-# Add second repo to same database  
-python index.py /path/to/logs2 --chroma-path ./shared_db
+# Add second folder to same database  
+python index.py /path/to/files2 --chroma-path ./shared_db
 ```
 
 ### Ollama Integration
@@ -311,13 +311,25 @@ Ensure Ollama is running with required models:
 
 ```bash
 # Install Ollama models
-ollama pull dolphincoder:15b
-ollama pull nomic-embed-text
+ollama pull qwen3:8b
+ollama pull nomic-embed-text:latest
 
 # Start Ollama (usually runs as service)
 ollama serve
 ```
 
+#### Useful Ollama ENV variables
+
+```bash
+OLLAMA_CONTEXT_LENGTH:8192 
+OLLAMA_DEBUG:INFO 
+OLLAMA_HOST:http://0.0.0.0:11434 
+OLLAMA_INTEL_GPU:false 
+OLLAMA_KEEP_ALIVE:3h
+OLLAMA_MAX_LOADED_MODELS:1 
+OLLAMA_MAX_QUEUE:512 
+```
+
 ## API Endpoints
 
 The embedding server provides RESTful endpoints:
@@ -361,6 +373,7 @@ The system uses a single standardized configuration:
 - **tiktoken**: Token counting utilities
 - **einops**: Tensor operations for advanced models
 - **requests**: HTTP client for remote services
+- **pypdf***: PDF parsing library
 
 ## File Structure
 
@@ -374,12 +387,8 @@ The system uses a single standardized configuration:
 └── chroma_db/           # Default ChromaDB storage (created after indexing)
 ```
 
-## License
-
-This project is designed for local development and research use. Please ensure compliance with the terms of service for any external models or APIs used.
-
 ## Contributions
 
 I welcome any assistance on this project, especially around trying new models for better performance and testing against ore logs than I have at my disposal!
 
-Please just fork off of dev and then submit a PR
+Please just fork off of dev and then submit a PR