Skip to content

Commit

Permalink
📃 docs: update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
chenjunjie committed Oct 4, 2023
1 parent 0696214 commit e33745b
Showing 1 changed file with 20 additions and 1 deletion.
21 changes: 20 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@
- [从源码安装](#从源码安装)
- [从PyPI安装](#从pypi安装)
- [🕹️基本用法](#️基本用法)
- [开启自动补全](#开启自动补全)
- [获取Github Personal Access Token](#获取github-personal-access-token)
- [获取OpenAI key](#获取openai-key)
- [config 命令](#config-命令)
Expand Down Expand Up @@ -120,8 +121,24 @@ pip3 install opendigger_pycli

<a id="基本用法"></a>

### 开启自动补全

zsh:

```zsh
eval "$(_OPENDIGGER_COMPLETE=zsh_source opendigger)"
```

bash:

```bash
eval "$(_FOO_BAR_COMPLETE=bash_source opendigger)"
```

### 获取Github Personal Access Token

Github Personal Access Token用于访问Github API,获取Github API的权限。通过Github API我们可以获取到Github上的仓库和用户的基本信息和自动反馈缺失数据。

[点击这里](https://github.com/settings/tokens?type=beta) 获取。

具体步骤:
Expand All @@ -146,7 +163,9 @@ pip3 install opendigger_pycli

### 获取OpenAI key

自行搜索教程
OpenAI key用于访问OpenAI API,获取OpenAI API的权限。通过OpenAI API我们可以对指标数据进行分析和生成洞察报告。

[点击这里](https://beta.openai.com/account/api-keys) 获取。

### config 命令

Expand Down

0 comments on commit e33745b

Please sign in to comment.