jason/atom
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 14 Wiki Activity

Added language description to README

Browse Source
This commit is contained in:
Jason Streifling 2024-10-18 18:00:38 +02:00
parent 574e2331a9
commit 411cd89b7c
1 changed files with 13 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
README.md
View File

@ -1,23 +1,24 @@
# atom # atom
An extensible Atom feed generator library that aims to be very close to An extensible Atom feed generator library that aims to be very close to RFC4287.
RFC4287. It diligently checks for compliance with the standard and provides It diligently checks for compliance with the standard and provides functions for
functions for easy creation and extension of elements. easy creation and extension of elements.
## Installation ## Installation
To install the latest version of the module, use the following command: To install the latest version of the module, use the following command:
``` ```sh
go get git.streifling.com/jason/atom@latest go get git.streifling.com/jason/atom@latest
``` ```
## Usage ## Usage
This library provides easy to use functions to create and extend elements of an This library provides easy to use functions to safely create and extend elements
Atom feed. The intended way of using it entails using these functions. and attributes of an Atom feed. The intended way of using it entails using these
functions.
``` ```go
package main package main
import ( import (
@ -60,10 +61,10 @@ func main() {
} }
``` ```
It is also possible to use this library in a way similar to what other It is also possible to use this library in a way similar to what other libraries
libraries would provide. This, of course, making it easier to make mistakes. would provide. This is, of course, making it easier to make mistakes.
``` ```go
package main package main
import ( 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
<?xml version="1.0" encoding="utf-8"?> <?xml version="1.0" encoding="utf-8"?>
<feed xmlns="http://www.w3.org/2005/Atom"> <feed xmlns="http://www.w3.org/2005/Atom">
<author> <author>