Skip to content

Commit 5e936d2

Browse files
committed
[README.md] add ToC, updated installation headers, updated license description
1 parent 2c95d78 commit 5e936d2

File tree

1 file changed

+11
-3
lines changed

1 file changed

+11
-3
lines changed

README.md

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,12 +10,20 @@
1010

1111
<img src="https://raw.githubusercontent.com/source-foundry/uni/img/img/uni3-crunch.png" alt="uni Line Filter Example" width="99%"/>
1212

13-
## Install
13+
## Contents
1414

15-
uni is developed in Go and compiled to the command line executable `uni` (`uni.exe` on Windows). A variety of cross-compiled binaries are available for use on Linux, macOS, and Windows systems, or you can download the source and compile the application yourself. Instructions for both approaches follow.
15+
- [Installation](#installation)
16+
- [Usage](#usage)
17+
- [Issues](#issues)
18+
- [Contributing](#contributing)
19+
- [License](#license)
1620

1721
## Installation
1822

23+
uni is developed in Go and compiled to the command line executable `uni` (`uni.exe` on Windows). A variety of cross-compiled binaries are available for use on Linux, macOS, and Windows systems, or you can download the source and compile the application yourself. Instructions for both approaches follow.
24+
25+
## Installation Approaches
26+
1927
### Approach 1: Install the pre-compiled binary executable file
2028

2129
Download the latest compiled release file for your operating system and architecture from [the Releases page](https://github.com/source-foundry/uni/releases/latest).
@@ -177,4 +185,4 @@ Contributions to the project are encouraged and welcomed. Please base your work
177185

178186
## License
179187

180-
[MIT License](https://github.com/source-foundry/uni/blob/master/LICENSE)
188+
uni is licensed under the [MIT License](https://github.com/source-foundry/uni/blob/master/LICENSE).

0 commit comments

Comments
 (0)