Skip to content

Commit

Permalink
changed README to README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
5v3n committed Jul 11, 2010
1 parent e54d34a commit 7fc9a17
Showing 1 changed file with 4 additions and 6 deletions.
10 changes: 4 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,24 +1,22 @@
== BlogHelper
# BlogHelper

Having a closer look at ruby based blogging platforms like [serious](http://github.com/colszowka/serious) and [toto](http://cloudhead.io/toto), I missed some functionality.

This a a collection of tools usable in both platforms.

=== Features
## Features

- tag your posts
- use seo friendly page titles
- use the disqus comment counter
- a workaround for seriuous allowing you to use generic yaml fields

=== Usage

==== Installation
## Installation

It's a piece of cake: just use the `gem` tool to get going with the _blog_helper_: `sudo gem install blog_helper`

If you want to use features that rely on accessing the http requests, like the _tag_ feature, you'll need to use the (_toto_prerelease_)[http://github.com/5v3n/toto]. Simply use `sudo gem install toto_prerelease --pre` to do so.

==== Applying a feature
## Usage

Piece of cake, again: all you have to do is use `<% require 'blog_helper'%>` in your .rhtml or .erb file and call the corresponding methods.

0 comments on commit 7fc9a17

Please sign in to comment.