From 7f953954a25071d55e61d33ec9f6641fe283de9c Mon Sep 17 00:00:00 2001
From: Jan Tuomi <jans.tuomi@gmail.com>
Date: Thu, 28 Dec 2017 14:05:57 +0200
Subject: Initial commit

---
 README.md | 28 ++++++++++++++++++++++++++++
 1 file changed, 28 insertions(+)
 create mode 100644 README.md

(limited to 'README.md')

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
-- 
cgit v1.3