diff options
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 11 |
1 files changed, 11 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..11c1466 --- /dev/null +++ b/README.md @@ -0,0 +1,11 @@ +# Go library for parsing Fedora CoreOS streams + +See the [Fedora CoreOS documentation](https://docs.fedoraproject.org/en-US/fedora-coreos/getting-started/) +for basic information about streams. + +This is a Go library which exposes API to decode streams into Go structs, +as well as a convenience API to find the URL for a given stream. + +# Example usage + +See [example code here](example/example.go). |