Skip to content

Commit 9a445f6

Browse files
authored
doc (#11)
1 parent 00f3249 commit 9a445f6

File tree

2 files changed

+22
-5
lines changed

2 files changed

+22
-5
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ Install fresh CLI
77
Start the project:
88

99
```sh
10-
deno task dev
10+
deno task start
1111
```
1212

1313
After adding, removing, or moving a page in the `routes` or directory, or

docs/getting-started/installation.md

Lines changed: 21 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,22 @@
1-
`pbkit` provides two clis.
1+
`pbkit` provides three clis.
22

3-
- `pb`: the protobuf schema compiler
4-
- `pollapo`: the package manager for protocol buffers.
3+
- `pb`: Protobuf schema compiler.
4+
- `pbkit`: Version manager for pbkit.
5+
- `pollapo`: Package manager for protobuf schemas.
6+
7+
# Recommended way
8+
9+
1. [Install Deno](https://deno.land/#installation)
10+
1. Setup `PATH` to your `$HOME/.zshrc` (or similar)
11+
```bash
12+
export PATH="$HOME/.deno/bin:$PATH"
13+
```
14+
1. Run below
15+
```bash
16+
deno run -A --unstable https://deno.land/x/pbkit/cli/pbkit/entrypoint.ts use
17+
```
18+
19+
# Other methods
520

621
## macOS
722

@@ -60,6 +75,8 @@ Make sure you have the following prerequisites installed:
6075
# clone pbkit repository
6176
git clone git@github.com:pbkit/pbkit.git
6277

63-
# Install pollapo command
78+
# Install pb, pbkit, pollapo command
6479
deno install -n pb -A --unstable pbkit/cli/pb/entrypoint.ts
80+
deno install -n pbkit -A --unstable pbkit/cli/pbkit/entrypoint.ts
81+
deno install -n pollapo -A --unstable pbkit/cli/pollapo/entrypoint.ts
6582
```

0 commit comments

Comments
 (0)