Skip to content

Update readme #18

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
chrisguox wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Update readme #18

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1e85190
Update readme
chrisguox Mar 14, 2025
90fca19
Update readme
chrisguox Mar 14, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@
<img alt="GitHub release" src="https://img.shields.io/badge/Release-Beta-yellow">
</a>
<!-- License -->
<a href="https://github.com/sentient-agi/Sentient-Agent-Framework/tree/main?tab=Apache-2.0-1-ov-file">
<a href="https://github.com/sentient-agi/Sentient-Agent-Framework/blob/main/LICENSE">
<img alt="License" src="https://img.shields.io/badge/License-Apache_2.0-green">
</a>
</p>
Expand Down Expand Up @@ -136,7 +136,7 @@ python3 -m src.agent.agent_tools.discord
Expected output:
```
Connecting to discord...
Connected to discrod bot <USERNAME> with id <USER_ID>.
Connected to discord bot <USERNAME> with id <USER_ID>.
```


Expand All @@ -151,13 +151,13 @@ INFO: Twitter client starting up...
INFO: Connected to twitter user <USERNAME> with id <USER_ID>.
INFO: Discord client starting up...
WARNING: PyNaCl is not installed, voice will NOT be supported
INFO: Connected to discrod bot <USERNAME> with id <USER_ID>.
INFO: Connected to discord bot <USERNAME> with id <USER_ID>.
```



# Configuration ⚙️
### Configurating Exisiting Tools
### Configuring Existing Tools
You can enable and disable tools in the `agent_config` module in the `agent` package. Each tool can be configured using its configuration module that is located in the tool's directory in the `agent_tools` directory. Each tool also has its own README file that describes its configuration options.

### Adding New Tools
Expand Down