Skip to content

Commit

Permalink
Docs tweaks
Browse files Browse the repository at this point in the history
  • Loading branch information
dmjones committed Oct 17, 2018
1 parent 60c226c commit 118d95b
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 8 deletions.
9 changes: 5 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,14 +5,15 @@

goreadme converts Go package documentation into Github-friendly markdown,
designed to be used as a README.md file. There is support for adding badges
for documentation and build status.
for documentation and build status. The README.md for this project is generated
using this tool.

### Installation
The recommended way to install is to download a binary from
It is recommended to download a binary from
<a href="https://github.com/dmjones/goreadme/releases">https://github.com/dmjones/goreadme/releases</a>.

If you'd like to build from the latest master commit instead, you must first
install `dep`: <a href="https://golang.github.io/dep/docs/installation.html">https://golang.github.io/dep/docs/installation.html</a>. Then
If you'd like to build from the latest source you must first
install dep (<a href="https://golang.github.io/dep/docs/installation.html">https://golang.github.io/dep/docs/installation.html</a>). Then
run these commands:


Expand Down
9 changes: 5 additions & 4 deletions docs.go
Original file line number Diff line number Diff line change
Expand Up @@ -15,15 +15,16 @@
/*
goreadme converts Go package documentation into Github-friendly markdown,
designed to be used as a README.md file. There is support for adding badges
for documentation and build status.
for documentation and build status. The README.md for this project is generated
using this tool.
Installation
The recommended way to install is to download a binary from
It is recommended to download a binary from
https://github.com/dmjones/goreadme/releases.
If you'd like to build from the latest master commit instead, you must first
install `dep`: https://golang.github.io/dep/docs/installation.html. Then
If you'd like to build from the latest source you must first
install dep (https://golang.github.io/dep/docs/installation.html). Then
run these commands:
go get -d github.com/dmjones/goreadme
Expand Down

0 comments on commit 118d95b

Please sign in to comment.