README.md in suspenders-1.20.0 vs README.md in suspenders-1.21.0
- old
+ new
@@ -3,12 +3,11 @@
Suspenders is the base Rails application used at
[thoughtbot](http://thoughtbot.com).
-Installation
-------------
+## Installation
First install the suspenders gem:
gem install suspenders
@@ -16,12 +15,11 @@
suspenders projectname
This will create a Rails app in `projectname` using the latest version of Rails.
-Gemfile
--------
+## Gemfile
To see the latest and greatest gems, look at Suspenders'
[Gemfile](templates/Gemfile.erb), which will be appended to the default
generated projectname/Gemfile.
@@ -44,10 +42,12 @@
* [Postgres](https://github.com/ged/ruby-pg) for access to the Postgres database
* [Rack Timeout](https://github.com/kch/rack-timeout) to abort requests that are
taking too long
* [Recipient Interceptor](https://github.com/croaky/recipient_interceptor) to
avoid accidentally sending emails to real people from staging
+* [Refills](https://github.com/thoughtbot/refills) for “copy-paste” components
+ and patterns based on Bourbon, Neat and Bitters
* [Simple Form](https://github.com/plataformatec/simple_form) for form markup
and style
* [Title](https://github.com/calebthompson/title) for storing titles in
translations
* [Unicorn](https://github.com/defunkt/unicorn) to serve HTTP requests
@@ -61,10 +61,12 @@
debugging behavior
* [Bundler Audit](https://github.com/rubysec/bundler-audit) for scanning the
Gemfile for insecure dependencies based on published CVEs
* [Spring](https://github.com/rails/spring) for fast Rails actions via
pre-loading
+* [Web Console](https://github.com/rails/web-console) for better debugging via
+ in-browser IRB consoles.
And testing gems like:
* [Capybara](https://github.com/jnicklas/capybara) and
[Capybara Webkit](https://github.com/thoughtbot/capybara-webkit) for
@@ -76,16 +78,16 @@
* [RSpec Mocks](https://github.com/rspec/rspec-mocks) for stubbing and spying
* [Shoulda Matchers](https://github.com/thoughtbot/shoulda-matchers) for common
RSpec matchers
* [Timecop](https://github.com/jtrupiano/timecop-console) for testing time
-Other goodies
--------------
+## Other goodies
Suspenders also comes with:
-* The [`./bin/setup`][bin] convention for new developer setup
+* The [`./bin/setup`][setup] convention for new developer setup
+* The `./bin/deploy` convention for deploying to Heroku
* Rails' flashes set up and in application layout
* A few nice time formats set up for localization
* `Rack::Deflater` to [compress responses with Gzip][compress]
* A [low database connection pool limit][pool]
* [Safe binstubs][binstub]
@@ -94,20 +96,19 @@
environments
* Configuration for [Travis Pro][travis] continuous integration
* The analytics adapter [Segment][segment] (and therefore config for Google
Analytics, Intercom, Facebook Ads, Twitter Ads, etc.)
-[bin]: http://robots.thoughtbot.com/bin-setup
+[setup]: http://robots.thoughtbot.com/bin-setup
[compress]: http://robots.thoughtbot.com/content-compression-with-rack-deflater/
[pool]: https://devcenter.heroku.com/articles/concurrency-and-database-connections
[binstub]: https://github.com/thoughtbot/suspenders/pull/282
[i18n]: https://github.com/thoughtbot/suspenders/pull/304
[travis]: http://docs.travis-ci.com/user/travis-pro/
[segment]: https://segment.io
-Heroku
-------
+## Heroku
You can optionally create Heroku staging and production apps:
suspenders app --heroku true
@@ -115,23 +116,25 @@
* Creates a staging and production Heroku app
* Sets them as `staging` and `production` Git remotes
* Configures staging with `RACK_ENV` and `RAILS_ENV` environment variables set
to `staging`
-* Adds the [Rails 12 Factor](https://github.com/heroku/rails_12factor) gem
- to make running Rails 4 apps easier on Heroku
+* Adds the [Rails Stdout Logging][logging-gem] gem
+ to configure the app to log to standard out,
+ which is how [Heroku's logging][heroku-logging] works.
-Git
----
+[logging-gem]: https://github.com/heroku/rails_stdout_logging
+[heroku-logging]: https://devcenter.heroku.com/articles/logging#writing-to-your-log
+## Git
+
This will initialize a new git repository for your Rails app. You can
bypass this with the `--skip-git` option:
suspenders app --skip-git true
-GitHub
-------
+## GitHub
You can optionally create a GitHub repository for the suspended Rails app. It
requires that you have [Hub](https://github.com/github/hub) on your system:
curl http://hub.github.com/standalone -sLo ~/bin/hub && chmod +x ~/bin/hub
@@ -139,12 +142,11 @@
This has the same effect as running:
hub create organization/project
-Dependencies
-------------
+## Dependencies
Suspenders requires the latest version of Ruby.
Some gems included in Suspenders have native extensions. You should have GCC
installed on your machine before generating an app with Suspenders.
@@ -160,33 +162,29 @@
installing QT are
[here](https://github.com/thoughtbot/capybara-webkit/wiki/Installing-Qt-and-compiling-capybara-webkit).
PostgreSQL needs to be installed and running for the `db:create` rake task.
-Issues
-------
+## Issues
If you have problems, please create a
[GitHub Issue](https://github.com/thoughtbot/suspenders/issues).
-Contributing
-------------
+## Contributing
To update Suspenders' Ruby version, change `.ruby-version` and `.travis.yml`.
Please see [CONTRIBUTING.md](CONTRIBUTING.md) for further details.
-Credits
--------
+## Credits
Suspenders is maintained and funded by
[thoughtbot, inc](http://thoughtbot.com/community).
The names and logos for thoughtbot are trademarks of thoughtbot, inc.
-License
--------
+## License
Suspenders is Copyright © 2008-2014 thoughtbot. It is free software, and may be
redistributed under the terms specified in the LICENSE file.