Updated README

apassant · Jul 5, 2014 · 830e139 · 830e139
1 parent 4d7f5c1
commit 830e139
Show file tree

Hide file tree

Showing 2 changed files with 54 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -1,4 +1,56 @@
 long-tail
 =========
 
-A Spotify widget playingan artist's least popular tracks - built with polymer
+A Spotify widget playing an artist's least popular tracks - built with polymer
+
+Install
+-------
+
+The easiest way is to install via Bower:
+
+    bower install long-tail
+
+Usage
+-----
+
+Import polyfill
+
+    <head>
+      <script src="bower_components/platform/platform.js"></script>
+    </head>
+
+Import custom element
+
+    <head>
+      <script src="bower_components/platform/platform.js"></script>
+      <link rel="import" href="bower_components/long-tail/long-tail.html">
+    </head>
+
+Load element
+
+    <body>
+      <long-tail artist="4tZwfgrHOc3mvqYlEYSvVi" size="25"></long-tail>
+    </body>
+
+Arguments
+---------
+
+* artist: A spotify artist ID
+* size: Number of tracks (max/default = 50)
+
+
+Demo
+----
+
+http://longtail.mdg.io
+
+License
+-------
+
+MIT
+
+Contact
+-------
+
+Alexandre Passant [http://apassant.net] + [http://mdg.io]
+
diff --git a/bower.json b/bower.json
@@ -1,6 +1,6 @@
 {
   "name": "long-tail",
-  "version": "0.1.1",
+  "version": "0.1.2",
   "description": "A Spotify widget playing an artist's least popular tracks",
   "keywords": [
     "Polymer",