Professional README with capabilities, TLDR, and accreditation

README.md

@@ -10,14 +10,57 @@ license: apache-2.0
 
 # ShellWhisperer-1.5B
 
-Fast shell/CLI specialist model by FableForge AI. 1GB, 29 tok/s.
+A fast, lightweight shell and CLI specialist model. Optimized for generating production-ready terminal code — bash scripts, Python automation, Docker commands, git workflows, and API calls.
 
-## API
+## TL;DR
 
+**1 GB · 29 tok/s · Free to use · Raw Ollama API**
+
+Focused prompts → working code. Not explanations. Not plans. The actual script, ready to save and run.
+
+## Capabilities
+
+### ✅ What It Can Do
+- Write complete bash scripts with functions, error handling, and logging
+- Generate Python automation and data processing scripts
+- Create Dockerfiles, compose files, and container commands
+- Build git workflows and version control operations
+- Construct API calls and curl commands
+- Handle system administration and file management tasks
+
+### ❌ What It Cannot Do
+- Frontend development (HTML, CSS, JavaScript)
+- Large file processing or full codebase rewrites
+- The context window is limited — prompts should target single functions or focused tasks
+
+## Usage
+
+The Space exposes a raw Ollama API at `/api/chat`:
+
+```bash
+curl -X POST https://karma-devops-shellwhisperer-demo.hf.space/api/chat \
+  -H "Content-Type: application/json" \
+  -d '{
+    "model": "FableForge-AI/shellwhisperer",
+    "messages": [{"role": "user", "content": "Write a bash script to monitor a directory for new files"}],
+    "stream": false
+  }'
 ```
-POST /api/chat
-{"model": "FableForge-AI/shellwhisperer", "messages": [{"role": "user", "content": "your prompt"}]}
-```
 
-- [GitHub: KingLabsA/mythos](https://github.com/KingLabsA/mythos)
-- [HuggingFace: fableforge-ai](https://huggingface.co/fableforge-ai)
+## Best Practices
+
+| Do | Don't |
+|----|-------|
+| Send focused, single-function prompts | Send entire files or codebases |
+| Ask for specific outputs (bash, Python, Docker) | Ask for frontend or UI code |
+| Review generated code before running | Assume output is production-ready without review |
+
+## Credits
+
+Built by **FableForge AI** as part of the Mythos model ecosystem.
+
+- **Original Repo:** [github.com/KingLabsA/mythos](https://github.com/KingLabsA/mythos)
+- **HuggingFace:** [huggingface.co/fableforge-ai](https://huggingface.co/fableforge-ai)
+- **License:** Apache 2.0
+
+*ShellWhisperer-1.5B is a fine-tuned shell specialist based on Qwen2.5-1.5B, part of the FableForge open-source agent ecosystem.*