diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..a49d781 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,18 @@ +# Changelog + +All notable changes to this project will be documented in this file. + +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), +and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). + +## [Unreleased] + +- Dockerfile + +## 0.1.0 - 2019-07-24 + +### Added + +- Initial release + +[unreleased]: https://github.com/olivierlacan/keep-a-changelog/compare/v0.1.0...HEAD diff --git a/README.md b/README.md index 883c30d..f645946 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ -# Outliner +# Outliner [![Gem Version](https://badge.fury.io/rb/outliner.svg)](https://badge.fury.io/rb/outliner) -A simple HTTParty based wrapper for the [Outline API](https://www.getoutline.com/developers). +A simple HTTParty based wrapper for the [Outline API](https://www.getoutline.com/developers). It also offers a one-line import option to let you migrate an existing set of Markdown files to Outline. ## Installation