gidget 0.0.2 → 0.0.3

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 (2) hide show
  1. data/README.rdoc +39 -1
  2. metadata +3 -3
@@ -1,6 +1,44 @@
1
1
  = gidget
2
2
 
3
- Description goes here.
3
+ The smallest taco-loving blog engine in the world!
4
+
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
+
7
+ = Basic Structure
8
+
9
+ * Sinatra based server
10
+ * A singleton array containing post information (the body of the a post is lazily-loaded)
11
+ * A class to handle post information
12
+
13
+ = Routing
14
+
15
+ * / - an index template with access to the full array of posts
16
+ * /2010 - an archive template with all access to all posts from the specified year
17
+ * /2010/11 - an archive template with access to all posts from the specified year/month
18
+ * /2010/11/19 - an archive template with access to all posts from the specified year/month/day
19
+ * /2010/11/19/first-post - a post template with access to the individual post
20
+ * /some-special-page - a page template with access to the full array of posts
21
+
22
+ = Post Creation
23
+
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
+
26
+ +title: My great post title
27
+ date: 2010-11-19+
28
+
29
+ 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
+
31
+ 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
+
33
+ = Heroku
34
+
35
+ 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
+
37
+ = TO BE DONE
38
+
39
+ * Create a simple generator to build out the stub of a web app using Gidget.
40
+ * Add a paging route to allow /page/1 type usage.
41
+ * Update the post route to pass the array of all posts and the current post index. This allows for previous/next links for each post to be created by the template.
4
42
 
5
43
  == Contributing to gidget
6
44
 
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: 27
4
+ hash: 25
5
5
  prerelease: false
6
6
  segments:
7
7
  - 0
8
8
  - 0
9
- - 2
10
- version: 0.0.2
9
+ - 3
10
+ version: 0.0.3
11
11
  platform: ruby
12
12
  authors:
13
13
  - Forrest Robertson