Skip to content

Commit 1ae0649

Browse files
committed
update README with improved variable documentation and command descriptions
1 parent 9dccc37 commit 1ae0649

1 file changed

Lines changed: 18 additions & 15 deletions

File tree

README.md

Lines changed: 18 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -22,18 +22,21 @@ docker run -d \
2222
ghcr.io/helltar/signai:latest
2323
```
2424

25-
Replace the example values with your own data:
26-
27-
- `BOT_NAME`, `BOT_USERNAME` - your desired bot name and username
28-
- `OPENAI_API_KEY` - your OpenAI API key
29-
- `CHAT_SYSTEM_PROMPT` - the system prompt for the chat
30-
- `GPT_MODEL` - the GPT model to use
31-
- `REQUESTS_PER_USER_PER_HOUR` - per-user hourly request limit for the chat command
32-
- `SIGNAL_API_URL` - the URL of your running `signal-cli-rest-api` instance
33-
- `SIGNAL_PHONE_NUMBER` - the phone number linked to bot Signal account
34-
35-
### Usage
36-
37-
- `chat` - Chat with the bot (Example: `chat How are you?`)
38-
- `chatctx` - View dialogue history
39-
- `chatrm` - Clear history
25+
| Variable | Description |
26+
| --- | --- |
27+
| `BOT_NAME` | Visible Signal profile name for the bot account |
28+
| `BOT_USERNAME` | Signal username to set for the bot account |
29+
| `OPENAI_API_KEY` | API key used for OpenAI requests |
30+
| `CHAT_SYSTEM_PROMPT` | System message injected into each new dialog context |
31+
| `GPT_MODEL` | OpenAI model name used for chat completions |
32+
| `REQUESTS_PER_USER_PER_HOUR` | Per-user limit for `chat` requests. Defaults to `30` |
33+
| `SIGNAL_API_URL` | URL to your `signal-cli-rest-api` service |
34+
| `SIGNAL_PHONE_NUMBER` | Bot account phone number in Signal |
35+
36+
### Bot Commands
37+
38+
- `chat <text>`: Ask the bot (example: `chat How are you?`)
39+
- `chatctx`: Show current dialog history
40+
- `chatrm`: Clear dialog history
41+
42+
**Tip**: If you reply directly to a bot message, it will be processed as a `chat` command automatically.

0 commit comments

Comments
 (0)