Permalink
Browse files

Update README.md

add example, howto and kudos to README
  • Loading branch information...
optikfluffel committed Aug 7, 2012
1 parent 7d888ef commit a6285d88ddc08a2b09f206889f2ffa21fa18937e
Showing with 23 additions and 3 deletions.
  1. +23 −3 README.md
View
@@ -1,4 +1,24 @@
-octopress-soundcloud
-====================
+# SoundCloud plugin for Jekyll
-Plugin for embedding soundcloud.com ressources in posts
+Helps you embed stuff from soundcloud more easily to your Octopress.
+
+## How to use it?
+
+There are 2 easy steps.
+
+1. Add ```soundcloud.rb``` to your ```plugin``` folder.
+2. Now you can easily embed sounds using the ```type``` and ```id``` or you can simply use the ```url```:
+
+```markdown
+# Soundcloud example 1 (uses type and id)
+
+{% soundcloud tracks 55172922 [option=value [option=value [...]]]%}
+
+# Soundcloud example 2 (uses url)
+
+{% soundcloud https://soundcloud.com/marinelli/fort-knox-five-presents-funk [option=value [option=value [...]]]%}
+```
+
+## Kudos
+
+Thanks go to [Nick Fisher](http://spadgos.github.com) for imeplenting the first version of this plugin for his blog.

0 comments on commit a6285d8

Please sign in to comment.