diff --git a/CHANGELOG.md b/CHANGELOG.md index da39eab..c75f224 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -5,10 +5,15 @@ All notable changes to this project will be documented in this file. The format is based on [Keep a Changelog](https://keepachangelog.com/) and this project adheres to [Semantic Versioning](https://semver.org/). -## [v1.0.0](https://github.com/virtualtam/opml-go/releases/tag/v1.0.0) - UNRELEASED - Initial release. +## [v1.0.0](https://github.com/virtualtam/opml-go/releases/tag/v1.0.0) - 2024-11-07 - ### Added +Initial release. - - Unmarshal data using the OPML file format - - Marshal documents containing text, feed subscription, link and directory elements +### Added + +- Unmarshal data using the OPML file format +- Marshal documents containing text, feed subscription, link and directory elements +- Setup Github Actions to run continuous integration workflows +- Add test coverage for OPML specification examples +- Add test coverage for Feedly and Newsblur feed subscription exports +- Add test examples to demonstrate usage diff --git a/README.md b/README.md index 3811306..f99e32a 100644 --- a/README.md +++ b/README.md @@ -5,6 +5,13 @@ `opml-go` provides a library to marshal and unmarshal outlines using the [Outline Processor Markup Language (OPML)](https://opml.org/spec2.opml) 2.0 format. +## Usage + +See examples under: + +- `example_marshal_test.go` to create an OPML document and marshal it to XML; +- `example_unmarshal_test.go` to read a file containing an OPML document. + ## Change Log See [CHANGELOG](./CHANGELOG.md)