gidget 0.0.2 → 0.0.3

data/README.rdoc

@@ -1,6 +1,44 @@
 = gidget
 
-Description goes here.
+The smallest taco-loving blog engine in the world!
+
+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.
+
+= Basic Structure
+
+* Sinatra based server
+* A singleton array containing post information (the body of the a post is lazily-loaded)
+* A class to handle post information
+
+= Routing
+
+* / - an index template with access to the full array of posts
+* /2010 - an archive template with all access to all posts from the specified year
+* /2010/11 - an archive template with access to all posts from the specified year/month
+* /2010/11/19 - an archive template with access to all posts from the specified year/month/day
+* /2010/11/19/first-post - a post template with access to the individual post
+* /some-special-page - a page template with access to the full array of posts
+
+= Post Creation
+
+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:
+
++title: My great post title
+date: 2010-11-19+
+
+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.
+
+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.
+
+= Heroku
+
+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.
+
+= TO BE DONE
+
+* Create a simple generator to build out the stub of a web app using Gidget.
+* Add a paging route to allow /page/1 type usage.
+* 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.
 
 == Contributing to gidget
  

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: gidget
 version: !ruby/object:Gem::Version 
-  hash: 27
+  hash: 25
   prerelease: false
   segments: 
   - 0
   - 0
-  - 2
-  version: 0.0.2
+  - 3
+  version: 0.0.3
 platform: ruby
 authors: 
 - Forrest Robertson