Skip to content

Commit

Permalink
Merge pull request #21 from DjangoPeng/v0.8
Browse files Browse the repository at this point in the history
update README
  • Loading branch information
DjangoPeng authored Sep 1, 2024
2 parents 522f5cf + edc867c commit cd06139
Show file tree
Hide file tree
Showing 4 changed files with 19 additions and 6 deletions.
13 changes: 10 additions & 3 deletions README-EN.md
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ pip install -r requirements.txt

### 2. Configure the Application

Edit the `config.json` file to set up your GitHub Token, Email settings (using Tencent WeCom Email as an example), subscription file, update settings, and large model service configurations (supporting OpenAI GPT API and Ollama private large model service):
Edit the `config.json` file to set up your GitHub Token, Email settings (using Tencent WeCom Email as an example), subscription file, update settings, large model service configurations (supporting OpenAI GPT API and Ollama private large model service) and report types autogenerated by LLMs:

```json
{
Expand All @@ -92,7 +92,11 @@ Edit the `config.json` file to set up your GitHub Token, Email settings (using T
"ollama_model_name": "llama3",
"ollama_api_url": "http://localhost:11434/api/chat"
},
"report_types": ["github"],
"report_types": [
"github",
"hacker_news_hours_topic",
"hacker_news_daily_report"
],
"slack": {
"webhook_url": "your_slack_webhook_url"
}
Expand Down Expand Up @@ -172,7 +176,10 @@ To run the application with a Gradio interface, allowing users to interact with
python src/gradio_server.py
```

![gradio_demo](images/gradio_demo.png)
![gradio_v0.8_github](images/gradio_v0.8_github.png)

![gradio_v0.8_hn](images/gradio_v0.8_hn.png)


- This will start a web server on your machine, allowing you to manage subscriptions and generate reports through a user-friendly interface.
- By default, the Gradio server will be accessible at `http://localhost:7860`, but it can be shared publicly if needed.
Expand Down
12 changes: 9 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@ pip install -r requirements.txt

### 2. 配置应用

编辑 `config.json` 文件,以设置您的 GitHub Token、Email 设置(以腾讯企微邮箱为例)、订阅文件、更新设置,以及大模型服务配置(支持 OpenAI GPT API 和 Ollama 私有化大模型服务):
编辑 `config.json` 文件,以设置您的 GitHub Token、Email 设置(以腾讯企微邮箱为例)、订阅文件、更新设置,大模型服务配置(支持 OpenAI GPT API 和 Ollama 私有化大模型服务),以及自动检索和生成的报告类型(GitHub项目进展, Hacker News 热门话题和前沿技术趋势):

```json
{
Expand All @@ -94,7 +94,11 @@ pip install -r requirements.txt
"ollama_model_name": "llama3",
"ollama_api_url": "http://localhost:11434/api/chat"
},
"report_types": ["github"],
"report_types": [
"github",
"hacker_news_hours_topic",
"hacker_news_daily_report"
],
"slack": {
"webhook_url": "your_slack_webhook_url"
}
Expand Down Expand Up @@ -175,7 +179,9 @@ python src/command_tool.py
python src/gradio_server.py
```

![gradio_demo](images/gradio_demo.png)
![gradio_v0.8_github](images/gradio_v0.8_github.png)

![gradio_v0.8_hn](images/gradio_v0.8_hn.png)

- 这将在您的机器上启动一个 Web 服务器,允许您通过用户友好的界面管理订阅和生成报告。
- 默认情况下,Gradio 服务器将可在 `http://localhost:7860` 访问,但如果需要,您可以公开共享它。
Expand Down
Binary file added images/gradio_v0.8_github.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/gradio_v0.8_hn.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit cd06139

Please sign in to comment.