readme

charliedowler · Sep 21, 2014 · 0148d32 · 0148d32
1 parent 8c0b099
commit 0148d32
Showing 1 changed file with 36 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -1,4 +1,40 @@
 ## Cal [![Build Status][travis-image]][travis-url]
 
+> Print a calender in your terminal
+
+## Getting Started
+```shell
+$ npm install -g cal
+```
+
+### Usage
+
+```js
+$ cal
+   September 2014
+Su Mo Tu We Th Fr Sa
+    1  2  3  4  5  6
+ 7  8  9 10 11 12 13
+14 15 16 17 18 19 20
+21 22 23 24 25 26 27
+28 29 30
+
+```
+
+### Options
+
+#### options.m
+Type: `Number`
+
+Set the month
+
+#### options.y
+Type: `Number`
+
+Set the year
+
+## Release History
+- 2014-09-21 v0.1.0 Initial release
+
 [travis-url]: http://travis-ci.org/charliedowler/cal
 [travis-image]: https://secure.travis-ci.org/charliedowler/cal.png?branch=master