From 652a9807ac7cca439213c265a13e99cbac1ee8ae Mon Sep 17 00:00:00 2001
From: Rafael Delboni <rafadelboni@gmail.com>
Date: Mon, 1 May 2023 16:52:40 -0300
Subject: [PATCH] docs: adds flow, tools and license

---
 README.md | 35 +++++++++++++++++++++++++++++++++++
 1 file changed, 35 insertions(+)

diff --git a/README.md b/README.md
index 6dcd722..2e5ddd4 100644
--- a/README.md
+++ b/README.md
@@ -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
@@ -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>