Skip to content

Commit affe11b

Browse files
DevMacdsantoreis
authored andcommitted
docs: add coverage badge, docs link, and roadmap to README
Co-authored-by: Daniel <dsantoreis@gmail.com>
1 parent eb13baa commit affe11b

1 file changed

Lines changed: 12 additions & 2 deletions

File tree

README.md

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
**Your support team answers questions in seconds, not hours.**
44

5-
[![CI](https://github.com/dsantoreis/askbase/actions/workflows/ci.yml/badge.svg)](https://github.com/dsantoreis/askbase/actions/workflows/ci.yml) [![License: MIT](https://img.shields.io/badge/License-MIT-green.svg)](./LICENSE) [![Release](https://img.shields.io/github/v/release/dsantoreis/askbase)](https://github.com/dsantoreis/askbase/releases/latest)
5+
[![CI](https://github.com/dsantoreis/askbase/actions/workflows/ci.yml/badge.svg)](https://github.com/dsantoreis/askbase/actions/workflows/ci.yml) [![Coverage](https://img.shields.io/badge/coverage-%E2%89%A580%25-brightgreen)](https://github.com/dsantoreis/askbase/actions/workflows/ci.yml) [![License: MIT](https://img.shields.io/badge/License-MIT-green.svg)](./LICENSE) [![Release](https://img.shields.io/github/v/release/dsantoreis/askbase)](https://github.com/dsantoreis/askbase/releases/latest) [![Docs](https://img.shields.io/badge/docs-GitHub%20Pages-blue)](https://dsantoreis.github.io/askbase/)
66

77
Askbase is a RAG-powered knowledge retrieval platform for support teams. Ingest your docs, ask questions in natural language, get grounded answers with precise citations — no hallucinations, no guesswork.
88

@@ -189,6 +189,16 @@ askbase/
189189

190190
---
191191

192+
## Roadmap
193+
194+
- [ ] Semantic embedding support (sentence-transformers, OpenAI ada)
195+
- [ ] Multi-tenant document isolation
196+
- [ ] Streaming answers via SSE
197+
- [ ] Document change detection and auto-reindex
198+
- [ ] Slack/Teams bot as first-class integration
199+
200+
---
201+
192202
## License
193203

194-
MIT see [LICENSE](./LICENSE).
204+
MIT -- see [LICENSE](./LICENSE).

0 commit comments

Comments
 (0)