Skip to content

Commit e3643d4

Browse files
authored
Update README.md
1 parent 9087374 commit e3643d4

File tree

1 file changed

+15
-8
lines changed

1 file changed

+15
-8
lines changed

README.md

Lines changed: 15 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -10,22 +10,29 @@ devDependencies: {
1010
}
1111
```
1212

13-
## Usage
14-
Register `TUI_GITHUB_TOKEN` as a environment variables
15-
16-
**Mac OS**
17-
```sh
18-
# ~/.bash_profile
19-
export TUI_GITHUB_TOKEN=github-personal-access-toke
13+
## Before Use
14+
1. Check `package.json` has `repository` property
15+
```json
16+
// package.json
17+
"repository": {
18+
"type": "git",
19+
"url": "https://github.com/username/repository-name.git"
20+
}
21+
// or for short expression
22+
"repository": "https://github.com/username/repository-name.git"
2023
```
2124

22-
Execute `tuie` on your `project root`
25+
2. Register `TUI_GITHUB_TOKEN` as a environment variables
26+
27+
3. Execute `tuie` on your `project root`
2328
```json
2429
// package.json
2530
scripts: {
2631
"tuie": "tuie"
2732
}
2833
```
34+
35+
## Usage
2936
```bash
3037
# latest tag
3138
npm run tuie

0 commit comments

Comments
 (0)