Skip to content

Commit 65b60ec

Browse files
committed
docs: provide information about usage
Close #19
1 parent 07c8762 commit 65b60ec

File tree

1 file changed

+44
-1
lines changed

1 file changed

+44
-1
lines changed

README.md

Lines changed: 44 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,48 @@
11
# Gitrelease
22

33
[![Continues Integration](https://github.com/arsham/gitrelease/actions/workflows/go.yml/badge.svg)](https://github.com/arsham/gitrelease/actions/workflows/go.yml)
4+
![License](https://img.shields.io/github/license/arsham/gitrelease)
45

5-
This program can set the release information based on all commits of a tag.
6+
This program can set the release information based on all commits of a tag. To
7+
see the example visit [Releases](https://github.com/arsham/gitrelease/releases)
8+
page.
9+
10+
1. [Requirements](#requirements)
11+
2. [Installation](#installation)
12+
3. [Usage](#usage)
13+
4. [License](#license)
14+
15+
## Requirements
16+
17+
This program requires `Go >= v1.17`.
18+
19+
## Installation
20+
21+
To install:
22+
23+
```bash
24+
go install github.com/arsham/gitrelease@latest
25+
```
26+
27+
## Usage
28+
29+
After you've made a tag, you can publish the current release documents by just
30+
running:
31+
32+
```bash
33+
gitrelease
34+
```
35+
36+
If you want to release an old tag:
37+
38+
```bash
39+
gitrelease -t v0.1.2
40+
```
41+
42+
## License
43+
44+
Licensed under the MIT License. Check the [LICENSE](./LICENSE) file for details.
45+
46+
<!--
47+
vim: foldlevel=1
48+
-->

0 commit comments

Comments
 (0)