alif-digest 1.1.2 → 1.1.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +15 -9
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -162,15 +162,21 @@ You can run Alif entirely in the cloud for free using GitHub Actions, without ev
|
|
|
162
162
|
|
|
163
163
|
1. **Fork this repository.**
|
|
164
164
|
2. Navigate to your fork's **Settings > Secrets and variables > Actions**.
|
|
165
|
-
3. Add your sensitive
|
|
166
|
-
|
|
167
|
-
|
|
168
|
-
|
|
169
|
-
|
|
170
|
-
|
|
171
|
-
|
|
172
|
-
|
|
173
|
-
- `
|
|
165
|
+
3. Add your sensitive access credentials as **Repository Secrets**.
|
|
166
|
+
4. Configure your preferences as **Repository Variables** (optional).
|
|
167
|
+
|
|
168
|
+
### Environment Variables Reference
|
|
169
|
+
|
|
170
|
+
| Variable | Type | Possible Values | Default | Description |
|
|
171
|
+
| ------------------------------ | -------- | ----------------------------------------- | ------------------- | ----------------------------------------------------------------------------- |
|
|
172
|
+
| `ALIF_LLM_PROVIDER` | Variable | `'anthropic'`, `'openrouter'`, `'ollama'` | `'anthropic'` | The AI provider to use for analysis. |
|
|
173
|
+
| `ALIF_LLM_API_KEY` | Secret | _Your API Key_ | - | Universal key. Alternatively use `ANTHROPIC_API_KEY` or `OPENROUTER_API_KEY`. |
|
|
174
|
+
| `ALIF_LLM_MODEL` | Variable | e.g. `'claude-3-5-sonnet-20240620'` | _Provider Specific_ | The specific model to use. |
|
|
175
|
+
| `SLACK_WEBHOOK_URL` | Secret | *https://hooks.slack.com/...* | - | Webhook URL for Slack delivery. |
|
|
176
|
+
| `GENERIC_WEBHOOK_URL` | Secret | _https://..._ | - | Webhook URL for generic server delivery. |
|
|
177
|
+
| `ALIF_SIGNAL_THRESHOLD` | Variable | `0` - `100` | `60` | Minimum score for an article to qualify. |
|
|
178
|
+
| `ALIF_MAX_ITEMS_PER_RUN` | Variable | `1`+ | `10` | Max articles delivered per run. |
|
|
179
|
+
| `ALIF_SOURCE_COOLDOWN_MINUTES` | Variable | `0`+ | `5` | Minimum gap between re-fetching a source. |
|
|
174
180
|
|
|
175
181
|
The included workflow (`.github/workflows/alif-scheduled-run.yml`) automatically runs every day at 8:00 AM UTC (feel free to change the schedule in your forked version), caches your database/state, and delivers your customized digest!
|
|
176
182
|
|