Initial commit

1 files changed, 28 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..2690125
--- /dev/null
+++ b/README.md
@@ -0,0 +1,28 @@
+# Create riot component
+
+Create a component skeleton for [riot.js](http://riotjs.com/). Designed to be used with ES6 import syntax and SASS.
+
+## Installation
+
+### With yarn
+`yarn global add create-riot-component`
+
+### With npm
+`npm install -g create-riot-component`
+
+## Usage
+
+`create-riot-component [component-name]`
+
+This command would create the following directory structure:
+
+```
+component-name
+  - component-name.tag
+  - component-name.scss
+  - index.js  // for importing the directory
+```
+
+## Author
+
+Jan Tuomi 2017
\ No newline at end of file