Updated the README to show a working example for the latest version (Closes #52) #53
Conversation
Codecov Report
@@ Coverage Diff @@
## master #53 +/- ##
=======================================
Coverage 38.25% 38.25%
=======================================
Files 7 7
Lines 677 677
=======================================
Hits 259 259
Misses 395 395
Partials 23 23 Continue to review full report at Codecov.
|
|
LGTM 👍 |
| import luno "github.com/luno/luno-go" | ||
| import ( |
There was a problem hiding this comment.
Suggest combining the imports:
import (
"log"
"context"
"time"
"github.com/luno/luno-go"
)
README.md
Outdated
| "log" | ||
| "context" | ||
| "time" | ||
| ) | ||
|
|
||
| lunoClient := luno.NewClient() |
There was a problem hiding this comment.
While you're at it, would you mind putting this in a func main() { } ?
README.md
Outdated
| if err != nil { | ||
| log.Fatal(err) | ||
| } | ||
| log.Println(res) | ||
| ``` | ||
|
|
||
| Remember to substitute `<API_KEY_ID>` and `<API_KEY_SECRET>` for your own Id and Secret. |
There was a problem hiding this comment.
nipick: lowercase id + secret
README.md
Outdated
| And then access them in Go like so: | ||
|
|
||
| ```go | ||
|
|
There was a problem hiding this comment.
nitpick: remove empty line
README.md
Outdated
|
|
||
| var API_KEY_ID string = os.Getenv("LUNO_API_ID") | ||
| var API_KEY_SECRET string = os.Getenv("LUNO_API_SECRET") | ||
|
|
There was a problem hiding this comment.
nitpick: remove empty line
| var API_KEY_SECRET string = os.Getenv("LUNO_API_SECRET") | ||
|
|
||
| ``` | ||
|
|
There was a problem hiding this comment.
nitpick: remove two empty lines
README.md
Outdated
| if err != nil { | ||
| log.Fatal(err) | ||
| } | ||
| log.Println(res) | ||
| ``` | ||
|
|
||
| Remember to substitute `<API_KEY_ID>` and `<API_KEY_SECRET>` for your own Id and Secret. | ||
|
|
||
| It is also recommended to set these as environment variables rather than include them in plaintext. You can do this on `BASH` with: |
There was a problem hiding this comment.
Suggest: We recommend using environment variables rather than including your credentials in plaintext. In bash you do so as follows:
README.md
Outdated
| It is also recommended to set these as environment variables rather than include them in plaintext. You can do this on `BASH` with: | ||
|
|
||
| ``` | ||
| $ set LUNO_API_ID="<API_KEY_ID>" |
There was a problem hiding this comment.
Yeah this one was a brain fart on my end...
|
@neilgarb Should be good now |
The README hadn't been updated for over a year.
Hence, the example provided does not actually work with the most recent version of the library.
I updated the README to show a full working example compatible with the most recent version of the library, which requires
Contextto be passed to the methods ofClient.