Skip to content

Commit

Permalink
Minor edits, updates
Browse files Browse the repository at this point in the history
  • Loading branch information
mrz1836 committed Apr 24, 2020
1 parent c92926e commit dbae17c
Showing 1 changed file with 52 additions and 13 deletions.
65 changes: 52 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,8 @@
[![Build Status](https://travis-ci.com/tonicpow/go-tonicpow.svg?branch=master)](https://travis-ci.com/tonicpow/go-tonicpow)
[![Report](https://goreportcard.com/badge/github.com/tonicpow/go-tonicpow?style=flat)](https://goreportcard.com/report/github.com/tonicpow/go-tonicpow)
[![Release](https://img.shields.io/github/release-pre/tonicpow/go-tonicpow.svg?style=flat)](https://github.com/tonicpow/go-tonicpow/releases)
[![standard-readme compliant](https://img.shields.io/badge/standard--readme-OK-green.svg?style=flat)](https://github.com/RichardLitt/standard-readme)
[![Slack](https://img.shields.io/badge/slack-tonicpow-orange.svg?style=flat)](https://atlantistic.slack.com/app_redirect?channel=tonicpow)
[![GoDoc](https://godoc.org/github.com/tonicpow/go-tonicpow?status.svg&style=flat)](https://godoc.org/github.com/tonicpow/go-tonicpow)
[![GoDoc](https://godoc.org/github.com/tonicpow/go-tonicpow?status.svg&style=flat)](https://pkg.go.dev/github.com/tonicpow/go-tonicpow)


## Table of Contents
Expand All @@ -30,7 +29,7 @@ $ go get -u github.com/tonicpow/go-tonicpow
```

## Documentation
You can view the generated [documentation here](https://godoc.org/github.com/tonicpow/go-tonicpow).
You can view the generated [documentation here](https://pkg.go.dev/github.com/tonicpow/go-tonicpow).

### Features
- [Client](client.go) is completely configurable
Expand All @@ -46,43 +45,83 @@ You can view the generated [documentation here](https://godoc.org/github.com/ton
- [x] [Visitors](https://docs.tonicpow.com/#d0d9055a-0c92-4f55-a370-762d44acf801)
- [x] [Rates](https://docs.tonicpow.com/#fb00736e-61b9-4ec9-acaf-e3f9bb046c89)

<details>
<summary><strong><code>Library Deployment</code></strong></summary>

[goreleaser](https://github.com/goreleaser/goreleaser) for easy binary or library deployment to Github and can be installed via: `brew install goreleaser`.

The [.goreleaser.yml](.goreleaser.yml) file is used to configure [goreleaser](https://github.com/goreleaser/goreleaser).

Use `make release-snap` to create a snapshot version of the release, and finally `make release` to ship to production.
</details>

<details>
<summary><strong><code>Makefile Commands</code></strong></summary>

View all `makefile` commands
```bash
$ make help
```

List of all current commands:
```text
all Runs test, install, clean, docs
bench Run all benchmarks in the Go application
clean Remove previous builds and any test cache data
clean-mods Remove all the Go mod cache
coverage Shows the test coverage
godocs Sync the latest tag with GoDocs
help Show all make commands available
lint Run the Go lint application
release Full production release (creates release in Github)
release-test Full production test release (everything except deploy)
release-snap Test the full release (build binaries)
tag Generate a new tag and push (IE: make tag version=0.0.0)
tag-remove Remove a tag if found (IE: make tag-remove version=0.0.0)
tag-update Update an existing tag to current commit (IE: make tag-update version=0.0.0)
test Runs vet, lint and ALL tests
test-short Runs vet, lint and tests (excludes integration tests)
update Update all project dependencies
update-releaser Update the goreleaser application
vet Run the Go vet application
```
</details>

## Examples & Tests
All unit tests and [examples](tonicpow_test.go) run via [Travis CI](https://travis-ci.org/tonicpow/go-tonicpow) and uses [Go version 1.14.x](https://golang.org/doc/go1.14). View the [deployment configuration file](.travis.yml).

View a [full example application](examples/examples.go).

Run all tests (including integration tests)
```bash
$ cd ../go-tonicpow
$ go test ./... -v
$ make test
```

Run tests (excluding integration tests)
```bash
$ cd ../go-tonicpow
$ go test ./... -v -test.short
$ make test-short
```

## Benchmarks
Run the Go [benchmarks](tonicpow_test.go):
```bash
$ cd ../go-tonicpow
$ go test -bench . -benchmem
$ make bench
```

## Code Standards
Read more about this Go project's [code standards](CODE_STANDARDS.md).

## Usage
- View the [examples & benchmarks](tonicpow_test.go)
View the [examples & benchmarks](tonicpow_test.go)

Basic implementation:
```golang
```go
package main

import (
"os"
"github.com/tonicpow/go-tonicpow"
"os"

"github.com/tonicpow/go-tonicpow"
)

func main() {
Expand Down

0 comments on commit dbae17c

Please sign in to comment.