Add installation instructions to README
This commit is contained in:
parent
1458b63287
commit
70716e847e
1 changed files with 9 additions and 1 deletions
10
README.md
10
README.md
|
|
@ -3,8 +3,16 @@
|
||||||
TODO: Write a project description
|
TODO: Write a project description
|
||||||
|
|
||||||
## Installation
|
## Installation
|
||||||
|
To use the library, simply import it into your application:
|
||||||
|
`import "github.com/otremblay/jkl"`
|
||||||
|
|
||||||
TODO: Describe the installation process
|
To install the command line application:
|
||||||
|
First, make sure you have a working go environment:
|
||||||
|
https://golang.org/doc/install
|
||||||
|
|
||||||
|
Then, execute the following command from your shell:
|
||||||
|
|
||||||
|
`$ go get github.com/otremblay/jkl/cmd/jkl`
|
||||||
|
|
||||||
## Usage
|
## Usage
|
||||||
|
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue