rollin 0.0.6 → 0.0.7

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (5) hide show
  1. checksums.yaml +4 -4
  2. data/.travis.yml +3 -0
  3. data/README.md +37 -13
  4. data/VERSION +1 -1
  5. metadata +2 -1
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA1:
3
- metadata.gz: 669c21a394800ac2d402f09a9278d9c1811b41b2
4
- data.tar.gz: 46c24726c6082ba0cda292028db3c4d543ab5dd1
3
+ metadata.gz: 3cef800013f4b82d068c82cbd8f98800d9803646
4
+ data.tar.gz: 06b8a572ece60514a38329c91d7dcc0cf56dec24
5
5
  SHA512:
6
- metadata.gz: ecb874bfc15b5cecbc3ee9f3881985dfce80c5febde3ec5f3131475c1a3da005fa775ceecadec9e791eff8c62aaef9fb19a4bcd779d49e399c5c422565d18124
7
- data.tar.gz: f9dbbf12c76357efe510d72a9eca3cb85059f7970850d7c74696f8b1d39d07e0ff8b8fc665c91468d9ba8b6faae2ed2a121cb330981a15143fa6fb356c1c15e1
6
+ metadata.gz: bd820de4043725f6b79ef36f850c77bf162527b7a442788316d3bd13790fca616aeccac387a708c1b87f8aaa53e7445a436934fb4b6e907c6172437c3c576231
7
+ data.tar.gz: 64386380473c5fa4025c5ad235619c52cf431bab511bdee0a58654e4a1cd730c088f81cdfa627b53b2d3acddb6d8e6168462d164f384079cc4eb4164ada5b129
data/.travis.yml ADDED
@@ -0,0 +1,3 @@
1
+ language: ruby
2
+ rvm:
3
+ - 2.0.0
data/README.md CHANGED
@@ -1,29 +1,53 @@
1
1
  # Rollin
2
2
 
3
- TODO: Write a gem description
3
+ A Ruby minimalistic filesystem based blog engine made for developers.
4
+
5
+ Different from other blog engines Rollin only does what matters, and leave the rest to you.
6
+
7
+ Rollin currently only supports Markdown format and uses the Github's awesome redcarpet.
4
8
 
5
9
  ## Installation
6
10
 
7
- Add this line to your application's Gemfile:
11
+ Add the dependency to your Gemfile:
8
12
 
9
13
  gem 'rollin'
10
14
 
11
- And then execute:
15
+ ## Usage
12
16
 
13
- $ bundle
17
+ ### Filesystem structure
14
18
 
15
- Or install it yourself as:
19
+ First you will need to have the following structure in your filesystem.
16
20
 
17
- $ gem install rollin
21
+ ├── my_posts
22
+ └── 2013_05_01_My_first_post.mk
18
23
 
19
- ## Usage
24
+ ### Getting articles
25
+
26
+ In your code.
27
+
28
+ blog = Rollin::Blog.new({article_folder: "my_posts"}) # Defaults to "articles"
29
+
30
+ anArticle = blog.articles.first
31
+
32
+ anArticle.date # => #<Date: 2013-05-01 ((2456414j,0s,0n),+0s,2299161j)>
33
+ anArticle.year # => 2013
34
+ anArticle.month # => 05
35
+ anArticle.day # => 01
36
+ anArticle.title # => "My first post"
37
+ anArticle.body # => "<h3>My first post!</h3>\n<p>blah blah blah</p>"
38
+
39
+ ### Getting the archive
40
+
41
+ a_monthly_archive = blog.monthly_archive.first
42
+
43
+ a_monthly_archive.year # => 2013
44
+ a_monthly_archive.month # => 5
45
+ a_monthly_archive.articles # => [ Rollin::Article(:title => "My first post" ...) ]
46
+
47
+ ## Build status
20
48
 
21
- TODO: Write usage instructions here
49
+ [![Build Status](https://travis-ci.org/marano/rollin.png)](https://travis-ci.org/marano/rollin)
22
50
 
23
51
  ## Contributing
24
52
 
25
- 1. Fork it
26
- 2. Create your feature branch (`git checkout -b my-new-feature`)
27
- 3. Commit your changes (`git commit -am 'Add some feature'`)
28
- 4. Push to the branch (`git push origin my-new-feature`)
29
- 5. Create new Pull Request
53
+ 1. Pull request!
data/VERSION CHANGED
@@ -1 +1 @@
1
- 0.0.6
1
+ 0.0.7
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: rollin
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.0.6
4
+ version: 0.0.7
5
5
  platform: ruby
6
6
  authors:
7
7
  - marano
@@ -89,6 +89,7 @@ extra_rdoc_files: []
89
89
  files:
90
90
  - .gitignore
91
91
  - .rvmrc
92
+ - .travis.yml
92
93
  - Gemfile
93
94
  - LICENSE.txt
94
95
  - README.md