diff --git a/README.md b/README.md index 64879f1..3d980e2 100644 --- a/README.md +++ b/README.md @@ -1,23 +1,24 @@ # atom -An extensible Atom feed generator library that aims to be very close to -RFC4287. It diligently checks for compliance with the standard and provides -functions for easy creation and extension of elements. +An extensible Atom feed generator library that aims to be very close to RFC4287. +It diligently checks for compliance with the standard and provides functions for +easy creation and extension of elements. ## Installation To install the latest version of the module, use the following command: -``` +```sh go get git.streifling.com/jason/atom@latest ``` ## Usage -This library provides easy to use functions to create and extend elements of an -Atom feed. The intended way of using it entails using these functions. +This library provides easy to use functions to safely create and extend elements +and attributes of an Atom feed. The intended way of using it entails using these +functions. -``` +```go package main import ( @@ -60,10 +61,10 @@ func main() { } ``` -It is also possible to use this library in a way similar to what other -libraries would provide. This, of course, making it easier to make mistakes. +It is also possible to use this library in a way similar to what other libraries +would provide. This is, of course, making it easier to make mistakes. -``` +```go package main import ( @@ -114,9 +115,9 @@ func main() { } ``` -The output of both ways of using it being an RFC4287 compliant Atom feed: +The output of both ways of using it is an RFC4287 compliant Atom feed: -``` +```xml