Skip to content
This repository has been archived by the owner on Jun 7, 2022. It is now read-only.

Commit

Permalink
Minor updates
Browse files Browse the repository at this point in the history
  • Loading branch information
mrz1836 committed Apr 30, 2020
1 parent 8b6cc57 commit 49db374
Show file tree
Hide file tree
Showing 3 changed files with 21 additions and 24 deletions.
14 changes: 7 additions & 7 deletions CODE_STANDARDS.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,19 +18,19 @@ View the [effective go](https://golang.org/doc/effective_go.html) standards docu
The package [golint](https://github.com/golang/lint) differs from [gofmt](https://golang.org/cmd/gofmt/). The package [gofmt](https://golang.org/cmd/gofmt/) formats Go source code, whereas [golint](https://github.com/golang/lint) prints out style mistakes. The package [golint](https://github.com/golang/lint) differs from [vet](https://golang.org/cmd/vet/). The package [vet](https://golang.org/cmd/vet/) is concerned with correctness, whereas [golint](https://github.com/golang/lint) is concerned with coding style. The package [golint](https://github.com/golang/lint) is in use at Google, and it seeks to match the accepted style of the open source [Go project](https://golang.org/).

How to install [golint](https://github.com/golang/lint):
```bash
$ go get -u golang.org/x/lint/golint
$ cd ../go-bitindex
$ golint
```shell script
go get -u golang.org/x/lint/golint
cd ../go-bitindex
golint
```

### *go vet* specifications
[Vet](https://golang.org/cmd/vet/) examines Go source code and reports suspicious constructs. [Vet](https://golang.org/cmd/vet/) uses heuristics that do not guarantee all reports are genuine problems, but it can find errors not caught by the compilers.

How to run [vet](https://golang.org/cmd/vet/):
```bash
$ cd ../go-bitindex
$ go vet -v
```shell script
cd ../go-bitindex
go vet -v
```

### *godoc* specifications
Expand Down
9 changes: 3 additions & 6 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,6 @@ COVER=go tool cover
## Default Repo Domain
GIT_DOMAIN=github.com

## Set the Github Token
#GITHUB_TOKEN=<your_token>

## Automatically detect the repo owner and repo name
REPO_NAME=$(shell basename `git rev-parse --show-toplevel`)
REPO_OWNER=$(shell git config --get remote.origin.url | sed 's/git@$(GIT_DOMAIN)://g' | sed 's/\/$(REPO_NAME).git//g')
Expand Down Expand Up @@ -41,11 +38,11 @@ lint: ## Run the Go lint application
golint

release: ## Full production release (creates release in Github)
goreleaser --rm-dist
make godocs
goreleaser --rm-dist
make godocs

release-test: ## Full production test release (everything except deploy)
goreleaser --skip-publish --rm-dist
goreleaser --skip-publish --rm-dist

release-snap: ## Test the full release (build binaries)
goreleaser --snapshot --skip-publish --rm-dist
Expand Down
22 changes: 11 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# go-bitindex
**go-bitindex** is the unofficial golang implementation for the [BitIndex API](https://www.bitindex.network/developers/api-documentation-v3.html)
> The unofficial Go implementation for the [BitIndex API](https://www.bitindex.network/developers/api-documentation-v3.html)
[![Go](https://img.shields.io/github/go-mod/go-version/mrz1836/go-bitindex)](https://golang.org/)
[![Build Status](https://travis-ci.com/mrz1836/go-bitindex.svg?branch=master&v=1)](https://travis-ci.com/mrz1836/go-bitindex)
Expand All @@ -21,8 +21,8 @@
## Installation

**go-bitindex** requires a [supported release of Go](https://golang.org/doc/devel/release.html#policy).
```bash
$ go get -u github.com/mrz1836/go-bitindex
```shell script
go get -u github.com/mrz1836/go-bitindex
```

## Documentation
Expand Down Expand Up @@ -57,8 +57,8 @@ Use `make release-snap` to create a snapshot version of the release, and finally
<summary><strong><code>Makefile Commands</code></strong></summary>

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

List of all current commands:
Expand Down Expand Up @@ -97,19 +97,19 @@ Examples & Tests by API section:
- [xpub](xpub_test.go)

Run all tests (including integration tests)
```bash
$ make test
```shell script
make test
```

Run tests (excluding integration tests)
```bash
$ make test-short
```shell script
make test-short
```

## Benchmarks
Run the Go [benchmarks](bitindex_test.go):
```bash
$ make bench
```shell script
make bench
```

## Code Standards
Expand Down

0 comments on commit 49db374

Please sign in to comment.