o5r/jkl
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Add installation instructions to README

Browse source
This commit is contained in:
Gabriel Guzman 2017-10-30 13:14:23 -04:00
parent 1458b63287
commit 70716e847e
1 changed files with 9 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

10
README.md
View file

@ -3,8 +3,16 @@
TODO: Write a project description
## 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