Add a CHANGELOG and update README

kjg · Oct 14, 2016 · 718c0ad · 718c0ad
1 parent 0a0efa0
commit 718c0ad
Show file tree

Hide file tree

Showing 2 changed files with 21 additions and 0 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -0,0 +1,15 @@
+# Changelog
+
+## Version 1.1.0
+
+*Unreleased*
+
+**Features**
+
+- Added an optional `-l, [--logo=LOGO]` option to specify a path to the custom logo file to use in the slate install
+
+## Version 1.0.0
+
+*September 29, 2016*
+
+Initial release
diff --git a/README.md b/README.md
@@ -52,6 +52,12 @@ To install slate into your docs folder run
   $ slate-installer install
 ```
 
+You can optionally specify the path to a custom logo to have that overwrite the slate logo during install
+
+```shell
+  $ slate-installer install -l path/to/logo.png
+```
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.