README.md in sweetie-0.1.2 vs README.md in sweetie-1.0.0

@@ -1,26 +1,83 @@
-Sweetie is a plugin for [jekyll](https://github.com/mojombo/jekyll) to count all links, images, pages, and the last build time on a jekyll site. You can then use this information at a any place in your jekyll project.
+Sweetie is a plugin for [jekyll](https://github.com/mojombo/jekyll) to count all links, images,
+pages, and the last build time on a jekyll site. You can then use this information at a any place in
+your jekyll project.[![Travis](http://travis-ci.org/matthias-guenther/sweetie.png)](http://travis-ci.org/matthias-guenther/sweetie)
 
 
-## Configuration variables
-To get the plugin working you must add `build`, `htmlpages`, `images`, and `links` in your `_config.yml` file. _sweetie_ will save the information to this variables. You can then use them everywhere in your page with the liquid snippet for example: 
+## Installation ##
 
-* `{{ site.build }}`
-* `{{ site.htmlpages }}`
-* `{{ site.images }}`
-* `{{ site.links }}`
+    gem install sweetie
 
-on all of your pages.
 
+## Possible usage ##
 
-## Installation
-Put the `sweetie.rb` file in the root of your jekyll project and then run the file to update your `_config.yml`file. To get the right calculated number of html pages, your pages must have the file ending *.html.
+The easiest way is to add `require 'sweetie'` on the top of your Rakefile.
 
+Before you build your page, you can run a rake task to update the status information of a page:
 
-## Possible usage
-Before you deploy your page, you can run the `sweetie.rb` in a rake task:
+    desc 'write stats in the _config.yml'
+    task :create_stati do
+      Sweetie::Conversion.conversion
+    end
 
-	desc "deploy"
-	task :create_stati do
-	  system("sweetie")
-	end
+A similar task can be implemented for the bitbucket repositories:
+
+    desc 'write stats in the _config.yml'
+    task :create_bitbucket do
+      Sweetie::Bitbucket.bitbucket("yourname")
+    end
+
+
+## Configuration variables of jekyll ##
+
+Call the class method `Sweetie::Bitbucket.bitbucket("yourname")` and it will automatically append
+the `build`, `htmlpages`, `images`, and `links` in your `_config.yml` file. You can then use them
+everywhere in your page with the liquid snippet for example:
+
+- `{{ site.build }}`
+- `{{ site.htmlpages }}`
+- `{{ site.images }}`
+- `{{ site.links }}`
+
+
+## Last changes of bitbucket repository ##
+
+Call the class method `Sweetie::Bitbucket.bitbucket("yourname")` and it will automatically append
+the repository name an the last change of the repository in your `_config.yml`. Here is an example:
+
+    git: 2011-10-16
+    pmwiki-twitter-recipe: 2011-10-29
+
+You can then use this variables in the view of your jekyll project with the liquid template. For
+example:
+
+    ### git ###
+
+    <section class="lastupdate">
+    Last update {{ site.git }}
+    </section>
+    ...
+
+
+    ### Twitter ###
+
+    <section class="lastupdate">
+    Last update {{ site.pmwiki-twitter-recipe }}
+    </section>
+    ...
+
+will result the following html:
+
+
+    <h3 id="git">Git</h3>
+
+    <section class="lastupdate">
+    Last update 2011-10-16
+    </section>
+
+
+    <h3 id="twitter">Twitter</h3>
+
+    <section class="lastupdate">
+    Last update 2011-10-16
+    </section>