Skip to content
Browse files

Updated README.

  • Loading branch information...
1 parent fed9a4a commit 23ccc3680b195cf2574f48629301123194892424 @marano committed
Showing with 21 additions and 23 deletions.
  1. +21 −23 README.md
View
44 README.md
@@ -1,10 +1,10 @@
-# Rollin
+# rollin
A Ruby minimalistic filesystem based blog engine made for developers.
-Different from other blog engines Rollin only does what matters, and leave the rest to you.
+Different from other blog engines, rollin only does what matters, and leave the rest to you.
-Rollin currently only supports Markdown format and uses the Github's awesome redcarpet.
+It currently supports Markdown format and uses the Github's awesome redcarpet.
## Installation
@@ -18,41 +18,39 @@ Add the dependency to your Gemfile:
First you will need to have the following structure in your filesystem.
- ├── my_posts
+ ├── posts
└── 2013_05_01_My_first_post.mk
### Articles
-
-In your code.
- blog = Rollin::Blog.new({article_folder: "my_posts"}) # Defaults to "articles"
+ blog = Rollin::Blog.new({articles_folder: "posts"}) # Defaults to "articles"
- anArticle = blog.articles.first
+ first_post = blog.articles.first
- anArticle.id # => "2013_05_01_My_first_post"
- anArticle.title # => "My first post"
- anArticle.body # => "<h3>My first post!</h3>\n<p>blah blah blah</p>"
+ first_post.id # => "2013_05_01_My_first_post"
+ first_post.title # => "My first post"
+ first_post.body # => "<h3>My first post!</h3>\n<p>blah blah blah</p>"
- anArticle.date # => #<Date: 2013-05-01 ((2456414j,0s,0n),+0s,2299161j)>
- anArticle.year # => 2013
- anArticle.month # => 05
- anArticle.day # => 01
+ first_post.date # => #<Date: 2013-05-01 ((2456414j,0s,0n),+0s,2299161j)>
+ first_post.year # => 2013
+ first_post.month # => 05
+ first_post.day # => 01
### Monthly archive
- a_monthly_archive = blog.monthly_archive.first
+ may_archive = blog.monthly_archive.first
- a_monthly_archive.year # => 2013
- a_monthly_archive.month # => 5
- a_monthly_archive.articles # => [ Rollin::Article(:title => "My first post" ...) ]
+ may_archive.year # => 2013
+ may_archive.month # => 5
+ may_archive.articles # => [ Rollin::Article(:title => "My first post" ...) ]
### Annual archive
- an_annual_archive = blog.annual_archive.first
+ twenty_thirteen_archive = blog.annual_archive.first
- an_annual_archive.year # => 2013
- an_annual_archive.articles # => [ Rollin::Article(:title => "My first post" ...) ]
- an_annual_archive.monthly_archive # => [ Rollin::MonthArchive(:year => 2013, :month => 5 ...) ]
+ twenty_thirteen_archive.year # => 2013
+ twenty_thirteen_archive.articles # => [ Rollin::Article(:title => "My first post" ...) ]
+ twenty_thirteen_archive.monthly_archive # => [ Rollin::MonthArchive(:year => 2013, :month => 5 ...) ]
### Finding an article

0 comments on commit 23ccc36

Please sign in to comment.
Something went wrong with that request. Please try again.