From 70716e847ef6c64dcf435f039fc1ceacfe398371 Mon Sep 17 00:00:00 2001 From: Gabriel Guzman Date: Mon, 30 Oct 2017 13:14:23 -0400 Subject: [PATCH] Add installation instructions to README --- README.md | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index eb6d017..bba324b 100644 --- a/README.md +++ b/README.md @@ -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