diff --git a/README.md b/README.md index 1dcb620..8ebcb1c 100644 --- a/README.md +++ b/README.md @@ -1,38 +1,23 @@ # toak +## Overview + +`toak` is a tool that processes git repository files, cleans code, redacts sensitive information, and generates markdown documentation with token counts using the Llama 3 tokenizer. + ```shell $ cd your-git-repo $ npx toak ``` -![toak](./toak.jpg) - - -## Overview - -`toak` is a tool that processes git repository files, cleans code, redacts sensitive information, and generates markdown documentation with token counts using the Llama 3 tokenizer. +![toak](https://github.com/seemueller-io/toak/blob/471c2a359e342c0103d2074650afe1f1b2b5f71d/toak.jpg?raw=true) --- + ## Philosophy -> Human-first technologies for a better tomorrow. +_Human-first_ technologies for a better future. --- -```mermaid -graph TD - Start[Start] -->|Read| Git[Git Files] - Git -->|Clean| TC[TokenCleaner] - TC -->|Redact| Clean[Clean Code] - Clean -->|Generate| MD[Markdown] - MD -->|Count| Results[Token Counts] - style Start fill:#000000,stroke:#FFFFFF,stroke-width:4px,color:#ffffff - style Git fill:#222222,stroke:#FFFFFF,stroke-width:2px,color:#ffffff - style TC fill:#333333,stroke:#FFFFFF,stroke-width:2px,color:#ffffff - style Clean fill:#444444,stroke:#FFFFFF,stroke-width:2px,color:#ffffff - style MD fill:#555555,stroke:#FFFFFF,stroke-width:2px,color:#ffffff - style Results fill:#666666,stroke:#FFFFFF,stroke-width:2px,color:#ffffff -``` - ## Features ### Data Processing diff --git a/package.json b/package.json index 8fa340f..b02cdc1 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "toak", - "version": "3.0.1", + "version": "3.0.2", "type": "module", "license": "AGPL-3.0-or-later", "repository": "https://github.com/seemueller-io/toak.git", diff --git a/toak.jpg b/toak.jpg deleted file mode 100644 index 029e96f..0000000 Binary files a/toak.jpg and /dev/null differ