Skip to content

Commit e1528d3

Browse files
committed
docs: Refine README's product description, features, and usage examples to better convey its value proposition.
1 parent 7174e38 commit e1528d3

1 file changed

Lines changed: 11 additions & 9 deletions

File tree

README.md

Lines changed: 11 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,9 @@
11
![Secrin Banner](/public/brand_banner.png)
22

33
<p align="center">
4-
<strong>Don't waste time on Q&A. Search less. Build more.</strong><br>
5-
Your engineering knowledge deserves better than scattered repos, Slack threads, and tribal memory.
4+
<strong>The living wiki that writes itself.</strong><br>
5+
Point Secrin at any codebase. It builds a knowledge graph, summarizes every function and class,<br>
6+
extracts your business domains, generates a Markdown wiki — and keeps it all in sync on every commit.
67
</p>
78

89
<p align="center">
@@ -21,19 +22,20 @@ Your engineering knowledge deserves better than scattered repos, Slack threads,
2122

2223
## What is Secrin?
2324

24-
Secrin indexes any codebase into a **Neo4j knowledge graph**, generates plain-English summaries for every function, class, and file via your LLM of choice, and produces a searchable Markdown wiki — fully automated, living alongside your code.
25+
Most wikis go stale the moment they're written. Secrin doesn't — because it never needed a human to write it in the first place.
2526

26-
```
27+
Secrin parses your codebase into a **Neo4j knowledge graph**, uses your LLM to generate plain-English summaries for every function, class, and file, identifies your business domains, and writes a structured Markdown wiki. A git hook keeps everything in sync automatically after every commit.
28+
29+
```bash
2730
secrin init # interactive setup → .secrin.yml
2831
secrin graph build --repo . # parse repo → Neo4j graph
2932
secrin analyze # LLM summaries + vector embeddings
3033
secrin domains # extract business domain concepts
3134
secrin generate # write docs/wiki/
32-
secrin chat "how does auth work?" # Q&A from the graph
35+
secrin chat "how does auth work?" # Q&A grounded in the graph
3336
```
3437

35-
> Teams don't slow down because they forget how to code.
36-
> They slow down because they forget *why* the code exists.
38+
New engineer on the team? Run `secrin chat "where should I add the billing endpoint?"` and get a direct, sourced answer — no archaeology required.
3739

3840
---
3941

@@ -464,5 +466,5 @@ and add its extension to `SUPPORTED_EXTENSIONS`.
464466

465467
Open an issue, propose a feature, or jump into the codebase.
466468

467-
> The goal isn't just to index code.
468-
> The goal is to remember as a team.
469+
> Documentation shouldn't be a second job.
470+
> It should be a side effect of writing good code.

0 commit comments

Comments
 (0)