Skip to content

Commit

Permalink
docs: adds flow, tools and license
Browse files Browse the repository at this point in the history
  • Loading branch information
rafaeldelboni committed May 1, 2023
1 parent 6b2d5fe commit 652a980
Showing 1 changed file with 35 additions and 0 deletions.
35 changes: 35 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,34 @@ Tool to extract namespace/functions documentation from Clojure projects into ind
clojure -X:extract
```

# Flow

```mermaid
sequenceDiagram;
autonumber
participant C as Config
participant A as Analysis
participant AD as Adapters
participant DB as Datalevin
participant CI
participant RE as Release
C->>A: Read file "resources/config.edn"
A->>A: Parse config projects to download
Note left of A: tools.deps
A->>A: Download projects
Note left of A: clj-kondo
A->>AD: Parse projects function/docs analysis
AD->>DB: Adapts & Indexes data into datoms
DB->>CI: Bulk-transact all datoms
CI->>RE: Zip and Publish
```

## Tools used
- [tools.deps](https://github.com/clojure/tools.deps) Download projects/libraries
- [clj-kondo](https://github.com/clj-kondo/clj-kondo) Parses/Analyses projects data
- [datalevin](https://github.com/juji-io/datalevin) Indexing and Storage of the data

# Developing

## Repl
Expand All @@ -25,3 +53,10 @@ clojure -M:dev:test
```bash
clojure -T:build uberjar
```

# Other iterations
- https://github.com/rafaeldelboni/clojure-document-extractor

# License
This is free and unencumbered software released into the public domain.
For more information, please refer to <http://unlicense.org>

0 comments on commit 652a980

Please sign in to comment.