Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
9 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,7 +1,15 @@ | ||
# prime | ||
|
||
This is a small Go package that serves as an example for how to write, test, and document Go libraries. | ||
This is a small Go package that serves as an example for how to write, test, and document Go libraries. It is covered in detail in the blog post ["The anatomy of a Go project"](http://darian.af/post/the-anatomy-of-a-golang-project/) | ||
|
||
## Install | ||
go get github.com/afshin/prime | ||
|
||
## Test | ||
go test -cover github.com/afshin/prime | ||
|
||
## Documentation | ||
[![API documentation](https://godoc.org/github.com/afshin/prime?status.svg)](https://godoc.org/github.com/afshin/prime) | ||
|
||
## Test coverage | ||
[![Coverage status](https://coveralls.io/repos/afshin/prime/badge.svg)](https://coveralls.io/r/afshin/prime) |