S/prepare for v0.3.0 release (#25)

.gitignore

@@ -63,3 +63,4 @@ typings/
 # lock file
 src/templates/**/yarn.lock
 src/templates/**/package-lock.json
+yarn.lock

CHANGELOG.md

@@ -3,6 +3,16 @@
 All notable changes to this project will be documented in this file.
 This project adheres to [Semantic Versioning](http://semver.org/).
 
+## 0.3.0 - 2019-04-18
+
+### Added
+
+* `--local` option for the `add` command (#22)
+
+### Fixed
+
+* cache plugins are not registered before provider plugins (#23)
+
 ## 0.2.0 - 2019-03-21
 
 ### Added

README.md

@@ -2,7 +2,15 @@
 
 [![npm package](https://img.shields.io/npm/v/@koopjs/cli.svg)](https://www.npmjs.com/package/@koopjs/cli) [![Build Status](https://travis-ci.org/koopjs/koop-cli.svg?branch=master)](https://travis-ci.org/koopjs/koop-cli)
 
-A cross-platform CLI tool to build [Koop](https://github.com/koopjs/koop) projects
+An easy-to-use CLI tool to quickly build [Koop](https://github.com/koopjs/koop) applications and plugins
+
+## Features
+
+* follow [Koop specification](https://koopjs.github.io/docs/usage/koop-core)
+* minimal project templates
+* full development cycle support
+* console commands + Node.js APIs
+* cross-platform
 
 ## Install
 
@@ -18,9 +26,43 @@ Use yarn
 yarn global add @koopjs/cli
 ```
 
-## Commands
+Once installed the `koop` command is available at the console.
+
+## Example
+
+Create a new Koop application with the name `my-koop-app`
 
-Once installed the `koop` command is available.
+``` bash
+# create a project folder and initialize it
+koop new app my-koop-app
+
+# cd in the folder
+cd my-koop-app
+```
+
+Add a provider [@koopjs/filesystem-s3](https://github.com/koopjs/koop-filesystem-s3) from npm
+
+``` bash
+# install the provider and register it to the koop app
+koop add provider @koopjs/filesystem-s3
+```
+
+Add a custom provider that connects to a local database
+
+``` bash
+# add boilerplate provider files at src/providers/local-db and register it to
+# the koop app (though you still need to implement the provider)
+koop add provider providers/local-db --local
+```
+
+Test out your work
+
+``` bash
+# run the koop server
+koop serve
+```
+
+## Commands
 
 ```
 koop <command>