Permalink
Browse files

Added skeleton for explaining padrino enhancements in parent README

  • Loading branch information...
1 parent 29fb91f commit 886c46aee06b7d5ce875d1fafbc4da1ebd06b99f @nesquena nesquena committed Nov 19, 2009
Showing with 46 additions and 1 deletion.
  1. +44 −1 README.rdoc
  2. +2 −0 TODO
View
@@ -68,4 +68,47 @@ To install the padrino framework, simply grab the latest version from gemcutter:
$ sudo gem install padrino --source http://gemcutter.org
This will install the necessary padrino gems to get you started.
-Now you are ready to use this gem to enhance your sinatra projects or to create new Padrino applications.
+Now you are ready to use this gem to enhance your sinatra projects or to create new Padrino applications.
+
+== Usage
+
+Padrino is a framework which builds on the existing functionality and Sinatra and provides a variety of
+additional tools and helpers to extend the foundation. This README and Padrino documentation in general will focus
+on the enhancements to the core Sinatra functionality. To use Padrino, one should be familiar with the basic
+usage of Sinatra itself. Resources for Sinatra are listed below:
+
+* README (http://www.sinatrarb.com/intro.html)
+* Book (http://www.sinatrarb.com/book.html)
+* Repo (http://github.com/sinatra/sinatra)
+
+Below is a guide to how this gem enhances the Sinatra framework as part of a 'full-stack' padrino application.
+For information on how to use a specific gem in isolation within an existing Sinatra project, checkout the README for that
+individual gem or gems.
+
+=== Enhanced Base Application (padrino-core)
+
+...
+
+=== Application Extensions and Helpers (padrino-helpers)
+
+...
+
+=== Advanced Routing Support (padrino-routing)
+
+...
+
+=== Agnostic Application Generators (padrino-gen)
+
+...
+
+=== Simple Mailer Support (padrino-mailer)
+
+...
+
+=== Painless Page and Fragment Caching (padrino-cache)
+
+...
+
+=== Admin Dashboard and Authentication (padrino-admin)
+
+...
View
@@ -37,6 +37,8 @@
* Add generator support for mounting subapplications
* Add support for migration generator types based on components
+ - fix the number prefix on migrations (http://guides.rubyonrails.org/migrations.html#whats-in-a-name)
+ - allow for special names to be interpreted (http://guides.rubyonrails.org/migrations.html#creating-a-standalone-migration)
* Add support for destroying existing controller, model, migrations, mailer
* Implement padrino-cache gem functionality
* Add helpers to helpers gem:

0 comments on commit 886c46a

Please sign in to comment.