Skip to content

Commit

Permalink
doc: refine
Browse files Browse the repository at this point in the history
  • Loading branch information
idiotWu committed Apr 26, 2024
1 parent 071253f commit 6139639
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 6 deletions.
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ Verify the installation by running `npi version`. If you see the output similar
#### Setting Up NPi Server

> [!TIP]
> Don't have installed Docker? Follow the official [Docker Installation Guide](https://docs.docker.com/get-docker/) to install Docker on your system.
> If Docker is not yet installed on your system, refer to the [Docker Installation Guide](https://docs.docker.com/get-docker/) for setup instructions.

Replace `YOUR_OAI_KEY` with your actual OpenAI API Key, then execute:
Expand All @@ -66,7 +66,7 @@ docker run -d --name npi --pull always \
-e OPENAI_API_KEY=YOUR_OAI_KEY npiai/npi
```

if you run on macOS, please use:
For macOS users, use this command instead:

```sh
docker run -d --name npi --pull always \
Expand All @@ -85,12 +85,12 @@ to [NPi GitHub Repository](https://github.com/npi-ai/npi/issues/new).
#### Authorize NPi to access your GitHub account

Generate a new token via [GitHub Tokens Page](https://github.com/settings/tokens) for NPi, you may need to grant the `repo` scope so that NPi can access
repositories on behalf of
you. ([Read more about scopes](https://docs.github.com/en/apps/oauth-apps/building-oauth-apps/scopes-for-oauth-apps))
repositories on behalf of you. ([Read more about scopes](https://docs.github.com/en/apps/oauth-apps/building-oauth-apps/scopes-for-oauth-apps))

![img.png](docs/assets/github-token-grant-repo.png)

and authorize NPi's access to your GitHub account with the following command.
Then, authorize NPi's access to your GitHub account with the following command:

```sh
npi auth github --access-token YOUR_GITHUB_ACCESS_TOKEN
```
Expand Down
2 changes: 1 addition & 1 deletion docs/pages/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ NPi (**N**atural-language **P**rogramming **I**nterface), pronounced as **"N π"

### Setting Up NPi Server
<Callout type={'info'}>
Don't have installed Docker? Follow the official [Docker Installation Guide](https://docs.docker.com/get-docker/) to install Docker on your system.
If Docker is not yet installed on your system, refer to the [Docker Installation Guide](https://docs.docker.com/get-docker/) for setup instructions.
</Callout>
Replace `YOUR_OAI_KEY` with your actual OpenAI API Key, then execute:

Expand Down

0 comments on commit 6139639

Please sign in to comment.