Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Newer
Older
100644 90 lines (62 sloc) 4.772 kb
efbe1c3 @nesquena [padrino] Remove all detailed information from top README. Leave in sub ...
nesquena authored
1 = Padrino
469974f @nesquena Initial commit after merging padrino subgems into single repo
nesquena authored
2
b6bb171 @DAddYE Nicer layout.
DAddYE authored
3 Padrino is the godfather of Sinatra. Follow us on
4 {www.padrinorb.com}[http://padrinorb.com] and on twitter
e375507 @DAddYE Added a couple of links in our readme.
DAddYE authored
5 {@padrinorb}[http://twitter.com/padrinorb]
6
ec8b5f5 @nesquena Move CI status into Padrino section
nesquena authored
7 {<img src="http://travis-ci.org/padrino/padrino-framework.png" />}[http://travis-ci.org/padrino/padrino-framework]
8
0b6a601 @nesquena Migrated existing README's from sinatra_more over to padrino gems
nesquena authored
9 == Preface
10
de30f28 @nesquena Cleanup root README file
nesquena authored
11 Padrino is a ruby framework built upon the excellent {Sinatra Web Library}[http://www.sinatrarb.com].
12 Sinatra is a DSL for creating simple web applications in Ruby quickly and with minimal effort.
13 This framework tries to make it as fun and easy as possible to code more advanced web applications by
14 building upon the Sinatra philosophies and foundations.
0b6a601 @nesquena Migrated existing README's from sinatra_more over to padrino gems
nesquena authored
15
16 == Introduction
17
de30f28 @nesquena Cleanup root README file
nesquena authored
18 Many people love that Sinatra is simple and lightweight but soon begin to miss the great deal
19 of functionality provided by other web frameworks such as Django or Rails when building non-trivial applications.
0b6a601 @nesquena Migrated existing README's from sinatra_more over to padrino gems
nesquena authored
20
de30f28 @nesquena Cleanup root README file
nesquena authored
21 Our goal with this framework is to adhere to the essence of Sinatra and at the same time create a standard library
22 of tools, helpers and components that will make Sinatra suitable for increasingly complex applications.
0b6a601 @nesquena Migrated existing README's from sinatra_more over to padrino gems
nesquena authored
23
c856f2e @nesquena [padrino] Truncating and fixing up additional parts of the README. Offlo...
nesquena authored
24 Here is a brief overview of functionality provided by the Padrino framework:
0b6a601 @nesquena Migrated existing README's from sinatra_more over to padrino gems
nesquena authored
25
eaad183 @nesquena [padrino-core] Fixes features table in readme
nesquena authored
26 Agnostic:: Full support for many popular testing, templating, mocking, and data storage choices.
27 Generators:: Create Padrino applications, models, controllers i.e: padrino-gen project.
28 Mountable:: Unlike other ruby frameworks, principally designed for mounting multiple apps.
29 Routing:: Full url named routes, named params, respond_to support, before/after filter support.
30 Tag Helpers:: View helpers such as: tag, content_tag, input_tag.
31 Asset Helpers:: View helpers such as: link_to, image_tag, javascript_include_tag.
32 Form Helpers:: Builder support such as: form_tag, form_for, field_set_tag, text_field.
3984c59 @nesquena Fix relative_time_ago => time_ago_in_words in docs
nesquena authored
33 Text Helpers:: Useful formatting like: time_ago_in_words, js_escape_html, sanitize_html.
eaad183 @nesquena [padrino-core] Fixes features table in readme
nesquena authored
34 Mailer:: Fast and simple delivery support for sending emails (akin to ActionMailer).
de30f28 @nesquena Cleanup root README file
nesquena authored
35 Caching:: Simple route and fragment caching to easily speed up your web requests.
eaad183 @nesquena [padrino-core] Fixes features table in readme
nesquena authored
36 Admin:: Builtin Admin interface (like Django)
37 Logging:: Provide a unified logger that can interact with your ORM or any library.
cbdc0e8 @DAddYE Whitespace fix!
DAddYE authored
38 Reloading:: Automatically reloads server code during development.
c629aac @nesquena [doc] Standardize quote chars in READMEs
nesquena authored
39 Localization:: Full support of I18n language localization and can auto-set user's locale.
0b6a601 @nesquena Migrated existing README's from sinatra_more over to padrino gems
nesquena authored
40
de30f28 @nesquena Cleanup root README file
nesquena authored
41 Keep in mind, developers are able to individually pull in these modular components
42 {into existing Sinatra applications}[http://www.padrinorb.com/guides/standalone-usage-in-sinatra]
43 or use them altogether for a full-stack Padrino application.
0b6a601 @nesquena Migrated existing README's from sinatra_more over to padrino gems
nesquena authored
44
45 == Installation
46
47 To install the padrino framework, simply grab the latest version from gemcutter:
48
df4d1ea @nesquena [README] Remove sudo from installation guide
nesquena authored
49 $ gem install padrino
9f8ac99 @DAddYE Stripped white spaces.
DAddYE authored
50
0b6a601 @nesquena Migrated existing README's from sinatra_more over to padrino gems
nesquena authored
51 This will install the necessary padrino gems to get you started.
886c46a @nesquena Added skeleton for explaining padrino enhancements in parent README
nesquena authored
52 Now you are ready to use this gem to enhance your sinatra projects or to create new Padrino applications.
53
de30f28 @nesquena Cleanup root README file
nesquena authored
54 For a more detailed look at installing Padrino,
493e0ea @DAddYE Updated our wiki links.
DAddYE authored
55 check out the {Installation Guide}[http://www.padrinorb.com/guides/installation].
c856f2e @nesquena [padrino] Truncating and fixing up additional parts of the README. Offlo...
nesquena authored
56
886c46a @nesquena Added skeleton for explaining padrino enhancements in parent README
nesquena authored
57 == Usage
58
9f8ac99 @DAddYE Stripped white spaces.
DAddYE authored
59 Padrino is a framework which builds on the existing functionality and Sinatra and provides a variety of
c856f2e @nesquena [padrino] Truncating and fixing up additional parts of the README. Offlo...
nesquena authored
60 additional tools and helpers to build upon that foundation. This README and Padrino documentation in general will focus
9f8ac99 @DAddYE Stripped white spaces.
DAddYE authored
61 on the enhancements to the core Sinatra functionality. To use Padrino, one should be familiar with the basic
62 usage of Sinatra itself.
886c46a @nesquena Added skeleton for explaining padrino enhancements in parent README
nesquena authored
63
de30f28 @nesquena Cleanup root README file
nesquena authored
64 You can also check out the {Getting Started}[http://www.padrinorb.com/guides/getting-started] guide
65 to learn more about how Sinatra and Padrino work together.
886c46a @nesquena Added skeleton for explaining padrino enhancements in parent README
nesquena authored
66
e632ee3 @nesquena [padrino] Truncating README's to shorten them and link to guides.
nesquena authored
67 For information on how to use a specific gem in isolation within an existing Sinatra project, checkout the guide for
de30f28 @nesquena Cleanup root README file
nesquena authored
68 {Using Padrino within Sinatra}[http://www.padrinorb.com/guides/standalone-usage-in-sinatra].
886c46a @nesquena Added skeleton for explaining padrino enhancements in parent README
nesquena authored
69
83d761e @nesquena [padrino] More additions / corrections on README
nesquena authored
70 == Getting Started
71
72 Once a developer understands Sinatra, Padrino is quite easy to get comfortable with since Padrino is simply a superset
de30f28 @nesquena Cleanup root README file
nesquena authored
73 of existing sinatra functionality!
efbe1c3 @nesquena [padrino] Remove all detailed information from top README. Leave in sub ...
nesquena authored
74
de30f28 @nesquena Cleanup root README file
nesquena authored
75 First, be sure to read over the {Getting Started}[http://www.padrinorb.com/guides/getting-started] guide
76 to learn more about how Sinatra and Padrino work together.
77
78 Best way to learn more about building Padrino applications is to read following resources:
83d761e @nesquena [padrino] More additions / corrections on README
nesquena authored
79
fc6be35 @DAddYE Updated links.
DAddYE authored
80 * {Padrino Guides}[http://www.padrinorb.com/guides] - Guides outlining the major functionality within Padrino.
493e0ea @DAddYE Updated our wiki links.
DAddYE authored
81 * {Blog Tutorial}[http://www.padrinorb.com/guides/blog-tutorial] - Step-by-step guide to building a blog application with Padrino.
de30f28 @nesquena Cleanup root README file
nesquena authored
82 * {Padrino API}[http://www.padrinorb.com/api/index.html] - YARD documentation for the Padrino framework.
493e0ea @DAddYE Updated our wiki links.
DAddYE authored
83 * {Quick Overview}[http://www.padrinorb.com/guides/basic-projects] - Outlines basic generation commands.
83d761e @nesquena [padrino] More additions / corrections on README
nesquena authored
84
f05e076 @nesquena [padrino] Adds additional resource links to README
nesquena authored
85 The individual Padrino sub-gems also contain README's which outlines their functionality.
7301590 [ALL] Adapted test to new changes.
Davide D'Agostino authored
86
87 == Copyright
93c87d2 @nesquena Added section in README about generators (padrino-core, padrino-gen)
nesquena authored
88
de347a6 @nesquena Fix copyright in README.rdoc
nesquena authored
89 Copyright (c) 2011 Padrino. See LICENSE for details.
Something went wrong with that request. Please try again.