diff --git a/README.md b/README.md index 331ac5b..5812a8e 100644 --- a/README.md +++ b/README.md @@ -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