Skip to content

Commit 61aaf4c

Browse files
committed
docs: update README.md
1 parent 32ce567 commit 61aaf4c

File tree

1 file changed

+42
-23
lines changed

1 file changed

+42
-23
lines changed

README.md

Lines changed: 42 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,12 @@
11
# TOAST UI Tools: Release Notes
22
> Github release notes generator.
33
4+
[![GitHub release](https://img.shields.io/github/release/nhn/toast-ui.release-notes.svg)](https://github.com/nhn/toast-ui.release-notes/releases/latest)
5+
[![npm](https://img.shields.io/npm/v/@toast-ui/release-notes.svg)](https://www.npmjs.com/package/@toast-ui/release-notes)
6+
[![GitHub license](https://img.shields.io/github/license/nhn/toast-ui.release-notes.svg)](https://github.com/nhn/toast-ui.release-notes/blob/production/LICENSE)
7+
[![PRs welcome](https://img.shields.io/badge/PRs-welcome-ff69b4.svg)](https://github.com/nhn/toast-ui.release-notes/labels/help%20wanted)
8+
[![code with hearth by NHN](https://img.shields.io/badge/%3C%2F%3E%20with%20%E2%99%A5%20by-NHN-ff1414.svg)](https://github.com/nhn)
9+
410
![image](https://user-images.githubusercontent.com/8615506/68182173-845baf80-ffdc-11e9-8c5d-52a3f4d26138.png)
511

612
## 🚩 Table of Contents
@@ -21,13 +27,25 @@
2127

2228
## 💾 Install
2329

24-
```javascript
25-
// package.json
26-
devDependencies: {
27-
"tui-release-notes": "git+https://github.com/nhn/tui.release-notes.git"
28-
}
30+
TOAST UI products can be used by using the package manager or downloading the source directly. However, we highly recommend using the package manager.
31+
32+
### Via Package Manager
33+
34+
TOAST UI products are registered in two package managers, [npm](https://www.npmjs.com/).
35+
You can conveniently install it using the commands provided by each package manager.
36+
When using npm, be sure to use it in the environment [Node.js](https://nodejs.org/) is installed.
37+
38+
#### npm
39+
40+
``` sh
41+
$ npm install --save-dev @toast-ui/release-notes # Latest version
42+
$ npm install --save-dev @toast-ui/release-notes@<version> # Specific version
2943
```
3044

45+
### Download Source Files
46+
* [Download all sources for each version](https://github.com/nhn/toast-ui.release-notes/releases)
47+
48+
3149
## 🔨 Usage
3250

3351
1. Check `package.json` has `repository` property. Repository url should end with `.git`.
@@ -42,12 +60,12 @@ devDependencies: {
4260
"repository": "https://github.com/username/repository-name.git"
4361
```
4462

45-
2. Register `TUI_GITHUB_TOKEN` as an environment variable or `token` property in `tui-note.config.js`.
63+
2. Register Github access token by `TUI_GITHUB_TOKEN` as an environment variable or `token` property in `tui-note.config.js`. To generate a token, please refer to [this](https://help.github.com/en/github/authenticating-to-github/creating-a-personal-access-token-for-the-command-line).
4664

4765
```javascript
4866
// tui-note.config.js
4967
module.exports = {
50-
token: 'your-github-token-for-tui-release-notes'
68+
token: 'your-github-token-for-toast-ui-release-notes'
5169
}
5270
```
5371

@@ -62,12 +80,13 @@ scripts: {
6280
4. Execute the command on your `project root`.
6381

6482
```bash
65-
# latest tag
83+
# tag specified in the tui-note.config.file
84+
# if you do not set a tag in a config file, latest tag
6685
npm run note
86+
6787
# specific tag
88+
# it will overwrite a tag in a config file
6889
npm run note -- --tag={specific-tag}
69-
# enterprise
70-
npm run note -- --apiUrl={github.your-enterprise-url.com/api/v3}
7190
```
7291

7392
### Add a config file
@@ -76,13 +95,13 @@ Add your config files to the root of your working directory. The config file mus
7695

7796
| Option | Type | Description |
7897
| --- | --- | --- |
79-
| `token` | `string` | Github access token for tui-release-note. If you pass a token as an environment variable, it will be overwritten. |
98+
| `token` | `string` | Github access token for toast-ui.release-notes. If you pass a token as an environment variable, it will be overwritten. |
8099
| `tag` | `string` | Tag to create a release note. If you pass a tag as the command line argument, it will be overwritten. (default: the latest tag) |
81-
| `apiUrl` | `string` | Github API url. If you use the enterprise github, set your enterprise github url. (default: https://api.github.com) |
82-
| `groupBy` | `object` | Determine how to categorize commits by their types. 'key' is `group name` and 'value' is `array of types`. (default: [defaultConfig.groupBy](https://github.com/nhn/tui.release-notes/blob/master/src/defaultConfig.js#L9)) |
83-
| `commitMessage.type` | `function` | Determine how to get a type from a commit message. (default: [defaultConfig.commitMessage.type](https://github.com/nhn/tui.release-notes/blob/master/src/defaultConfig.js#L21)) |
84-
| `template.commit` | `function` | Note from a commit. (default: [defaultConfig.template.commit](https://github.com/nhn/tui.release-notes/blob/master/src/defaultConfig.js#L33)) |
85-
| `downloads` | `function \| object` | Links to download the files. (reference: [defaultConfig.downloads](https://github.com/nhn/tui.release-notes/blob/master/src/defaultConfig.js#L47)) |
100+
| `apiUrl` | `string` | Github API url. If you use the enterprise github, set your enterprise github url (ex. github.your-enterprise-url.com/api/v3). (default: https://api.github.com) |
101+
| `groupBy` | `object` | Determine how to categorize commits by their types. 'key' is `group name` and 'value' is `array of types`. (default: [defaultConfig.groupBy](https://github.com/nhn/toast-ui.release-notes/blob/master/src/defaultConfig.js#L9)) |
102+
| `commitMessage.type` | `function` | Determine how to get a type from a commit message. (default: [defaultConfig.commitMessage.type](https://github.com/nhn/toast-ui.release-notes/blob/master/src/defaultConfig.js#L21)) |
103+
| `template.commit` | `function` | Note from a commit. (default: [defaultConfig.template.commit](https://github.com/nhn/toast-ui.release-notes/blob/master/src/defaultConfig.js#L33)) |
104+
| `downloads` | `function \| object` | Links to download the files. (reference: [defaultConfig.downloads](https://github.com/nhn/toast-ui.release-notes/blob/master/src/defaultConfig.js#L47)) |
86105

87106

88107
## 🔧 Pull Request Steps
@@ -97,8 +116,8 @@ Clone it to local computer. Install node modules.
97116
Before starting development, you should check to haveany errors.
98117

99118
``` sh
100-
$ git clone https://github.com/{your-personal-repo}/tui.release-notes.git
101-
$ cd tui.release-notes
119+
$ git clone https://github.com/{your-personal-repo}/toast-ui.release-notes.git
120+
$ cd toast-ui.release-notes
102121
$ npm install
103122
$ npm run test
104123
```
@@ -123,10 +142,10 @@ For more information on PR's step, please see links of Contributing section.
123142

124143

125144
## 💬 Contributing
126-
* [Code of Conduct](https://github.com/nhn/tui.release-notes/blob/master/CODE_OF_CONDUCT.md)
127-
* [Contributing guideline](https://github.com/nhn/tui.release-notes/blob/master/CONTRIBUTING.md)
128-
* [Issue guideline](https://github.com/nhn/tui.release-notes/blob/master/docs/ISSUE_TEMPLATE.md)
129-
* [Commit convention](https://github.com/nhn/tui.release-notes/blob/master/docs/COMMIT_MESSAGE_CONVENTION.md)
145+
* [Code of Conduct](https://github.com/nhn/toast-ui.release-notes/blob/master/CODE_OF_CONDUCT.md)
146+
* [Contributing guideline](https://github.com/nhn/toast-ui.release-notes/blob/master/CONTRIBUTING.md)
147+
* [Issue guideline](https://github.com/nhn/toast-ui.release-notes/blob/master/docs/ISSUE_TEMPLATE.md)
148+
* [Commit convention](https://github.com/nhn/toast-ui.release-notes/blob/master/docs/COMMIT_MESSAGE_CONVENTION.md)
130149

131150

132151
## 🍞 TOAST UI Family
@@ -140,4 +159,4 @@ For more information on PR's step, please see links of Contributing section.
140159

141160

142161
## 📜 License
143-
This software is licensed under the [MIT License](https://github.com/nhn/tui.release-notes/blob/master/LICENSE) © [NHN](https://github.com/nhn).
162+
This software is licensed under the [MIT License](https://github.com/nhn/toast-ui.release-notes/blob/master/LICENSE) © [NHN](https://github.com/nhn).

0 commit comments

Comments
 (0)