Skip to content

Commit

Permalink
Update readme according to go doc
Browse files Browse the repository at this point in the history
  • Loading branch information
posener committed Apr 6, 2019
1 parent c47a19c commit 01dc223
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Package goreadme creates readme markdown file from go doc.

This package can be used as a web service, as a command line tool or as a library.

Try the [web service](https://gotreadme.herokuapp.com).
Try the [web service](https://goreadme.herokuapp.com).

Integrate directly with [Github](https://github.com/apps/goreadme).

Expand Down Expand Up @@ -46,13 +46,13 @@ Meaning:

* Inline code is marked with backticks.

* URLs will just automatically converted to links.
* URLs will just automatically be converted to links.

Additionally, some extra formatting was added.

* Local paths will be automatically converted to links, for example: [./goreadme.go](./goreadme.go).

* A url and can have a title, as follows: [goreadme website](https://goreadme.herokuapp.com).
* A URL and can have a title, as follows: [goreadme website](https://goreadme.herokuapp.com).

* A local path and can have a title, as follows: [goreadme main file](./goreamde.go).

Expand Down

0 comments on commit 01dc223

Please sign in to comment.