Skip to content

Commit

Permalink
Updated README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
antoninoLorenzo committed Jun 19, 2024
1 parent c5eee32 commit cd0e4c1
Showing 1 changed file with 11 additions and 1 deletion.
12 changes: 11 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,14 +37,24 @@ it enhances great programmers and make them more productive; that's the same obj

### Key Features

**TODO:** *LLM integrations, Knowledge, Collections, Tools etc.*
- **Full Open-Source** : this project do not require any subscription to third party LLM providers, we use
[Ollama](https://github.com/ollama/ollama) as main LLM provider, meaning that you can use <ins>whatever model you
want</ins>.
- **Tool Integration** : the agent can execute Penetration Testing tools, not only the most common tools are available
(see [Available Tools](#available-tools)), but you can integrate a <ins>whatever tool you want</ins> without knowing
how to code in Python (see [Add a Tool](#add-a-tool)).
- **Up-to-date Knowledge** : the agent won't leverage only training information, there is a `RAG` system available that
enables the agent to get up-to-date knowledge, and you can add <ins>whatever document you want</ins> (see
[Add a Collection](#add-a-collection)).

## 💻 Install

### End-User
**Requirements**
- Ollama
- Docker
- Minimum hardware requirements to-be-defined


1. **TODO:** *work in progress*

Expand Down

0 comments on commit cd0e4c1

Please sign in to comment.