gidget 0.0.3 → 0.0.4

Sign up to get free protection for your applications and to get access to all the features.
Files changed (2) hide show
  1. data/README.rdoc +9 -7
  2. metadata +3 -3
data/README.rdoc CHANGED
@@ -4,13 +4,13 @@ The smallest taco-loving blog engine in the world!
4
4
 
5
5
  Gidget is a minimalist blog engine designed to run on Heroku with a Git-based workflow. It is built upon Sinatra and uses Haml and rdiscount for templating/markup. It was largely inspired by Toto, however Gidget was built on top of a DSL to minimize code.
6
6
 
7
- = Basic Structure
7
+ == Basic Structure
8
8
 
9
9
  * Sinatra based server
10
10
  * A singleton array containing post information (the body of the a post is lazily-loaded)
11
11
  * A class to handle post information
12
12
 
13
- = Routing
13
+ == Routing
14
14
 
15
15
  * / - an index template with access to the full array of posts
16
16
  * /2010 - an archive template with all access to all posts from the specified year
@@ -19,22 +19,24 @@ Gidget is a minimalist blog engine designed to run on Heroku with a Git-based wo
19
19
  * /2010/11/19/first-post - a post template with access to the individual post
20
20
  * /some-special-page - a page template with access to the full array of posts
21
21
 
22
- = Post Creation
22
+ == Post Creation
23
23
 
24
24
  Posts are simply .txt files located under a folder named posts located off the root of the web app. Text files contain two sections of data. The first is metadata including at least a title and date as such:
25
25
 
26
- +title: My great post title
27
- date: 2010-11-19+
26
+ <code>
27
+ title: My great post title<br/>
28
+ date: 2010-11-19
29
+ </code>
28
30
 
29
31
  The second section is the body of the post and uses markdown as it's markup language. The two sections should be separated by an empty line.
30
32
 
31
33
  File name and structure (other than the .txt extension) don't matter. Gidget will determine request paths off of the date and title metadata and sort them accordingly.
32
34
 
33
- = Heroku
35
+ == Heroku
34
36
 
35
37
  Gidget is meant to run on a Heroku. It offers version management through Git, and uses the advantages provided by running behind a reverse-proxy cache such as Varnish. Gidget is meant to be minimalist in design while taking these factors into consideration.
36
38
 
37
- = TO BE DONE
39
+ == TO BE DONE
38
40
 
39
41
  * Create a simple generator to build out the stub of a web app using Gidget.
40
42
  * Add a paging route to allow /page/1 type usage.
metadata CHANGED
@@ -1,13 +1,13 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: gidget
3
3
  version: !ruby/object:Gem::Version
4
- hash: 25
4
+ hash: 23
5
5
  prerelease: false
6
6
  segments:
7
7
  - 0
8
8
  - 0
9
- - 3
10
- version: 0.0.3
9
+ - 4
10
+ version: 0.0.4
11
11
  platform: ruby
12
12
  authors:
13
13
  - Forrest Robertson