Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
youjung-hong committed Aug 21, 2017
1 parent 9087374 commit e3643d4
Showing 1 changed file with 15 additions and 8 deletions.
23 changes: 15 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,22 +10,29 @@ devDependencies: {
}
```

## Usage
Register `TUI_GITHUB_TOKEN` as a environment variables

**Mac OS**
```sh
# ~/.bash_profile
export TUI_GITHUB_TOKEN=github-personal-access-toke
## Before Use
1. Check `package.json` has `repository` property
```json
// package.json
"repository": {
"type": "git",
"url": "https://github.com/username/repository-name.git"
}
// or for short expression
"repository": "https://github.com/username/repository-name.git"
```

Execute `tuie` on your `project root`
2. Register `TUI_GITHUB_TOKEN` as a environment variables

3. Execute `tuie` on your `project root`
```json
// package.json
scripts: {
"tuie": "tuie"
}
```

## Usage
```bash
# latest tag
npm run tuie
Expand Down

0 comments on commit e3643d4

Please sign in to comment.