Skip to content

Commit 1479dc8

Browse files
authored
Merge pull request #33 from SecrinLabs/ronaldo
Ronaldo
2 parents 5d15a71 + c4f8c71 commit 1479dc8

2 files changed

Lines changed: 13 additions & 9 deletions

File tree

README.md

Lines changed: 13 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,11 @@
1+
# Secrin - The living wiki that writes itself
2+
13
![Secrin Banner](/public/brand_banner.png)
24

35
<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.
6+
<strong>The living wiki that writes itself.</strong><br>
7+
Point Secrin at any codebase. It builds a knowledge graph, summarizes every function and class,<br>
8+
extracts your business domains, generates a Markdown wiki — and keeps it all in sync on every commit.
69
</p>
710

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

2225
## What is Secrin?
2326

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.
27+
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.
2528

26-
```
29+
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.
30+
31+
```bash
2732
secrin init # interactive setup → .secrin.yml
2833
secrin graph build --repo . # parse repo → Neo4j graph
2934
secrin analyze # LLM summaries + vector embeddings
3035
secrin domains # extract business domain concepts
3136
secrin generate # write docs/wiki/
32-
secrin chat "how does auth work?" # Q&A from the graph
37+
secrin chat "how does auth work?" # Q&A grounded in the graph
3338
```
3439

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

3842
---
3943

@@ -464,5 +468,5 @@ and add its extension to `SUPPORTED_EXTENSIONS`.
464468

465469
Open an issue, propose a feature, or jump into the codebase.
466470

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

public/brand_banner.png

-169 KB
Loading

0 commit comments

Comments
 (0)