README.md in philosophies-suspenders-2.0.0 vs README.md in philosophies-suspenders-2.0.2
- old
+ new
@@ -1,17 +1,23 @@
# Suspenders
+[![Stories in Backlog](https://badge.waffle.io/philosophie/suspenders.svg?label=ready&title=Backlog)](http://waffle.io/philosophie/suspenders)
+
This is Philosophie's fork of Suspenders, a Rails application template
originally created by thoughtbot. This repo has strayed significantly from
thoughtbot's and is not intended to go back upstream.
## Installation
First install the gem:
gem install philosophies-suspenders
+Or update if you already have the gem installed:
+
+ gem update philosophies-suspenders
+
Then run:
philosophies-suspenders projectname
This will create a Rails app in `projectname` using the latest version of Rails.
@@ -30,11 +36,10 @@
set your API key in the environment with `AIRBRAKE_API_KEY`
* [Autoprefixer Rails](https://github.com/ai/autoprefixer-rails) for CSS vendor prefixes
* [Sidekiq](https://github.com/mperham/sidekiq) for background processing
* [Flutie](https://github.com/thoughtbot/flutie) for `page_title` and `body_class` view
helpers
-* [High Voltage](https://github.com/thoughtbot/high_voltage) for static pages
* [Rails Assets](https://rails-assets.org/) for managing frontend dependencies,
including by default:
* jquery
* jquery-ujs
* [New Relic RPM](https://github.com/newrelic/rpm) for monitoring performance
@@ -98,10 +103,17 @@
[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
[segment]: https://segment.com
+## CSS Frameworks
+
+You can optionally install a CSS Framework
+options: bourbon_n_friends, bootstrap, foundation
+
+ philosophies-suspenders my_new_app --css-framework=CSS_FRAMEWORK
+
## Heroku
By default, suspenders will:
* Creates a staging and production Heroku app
@@ -115,11 +127,11 @@
[rails-12factor]: https://github.com/heroku/rails_12factor
You can optionally specify alternate Heroku flags:
- suspenders app \
+ philosophies-suspenders app \
--heroku-flags "--region eu --addons newrelic,pgbackups,ssl"
See all possible Heroku flags:
heroku help create
@@ -141,18 +153,18 @@
suspenders app --origin git@github.com:philosopie/app.git
You can bypass all git functionality with the `--skip-git` option:
- suspenders app --skip-git true
+ philosophies-suspenders app --skip-git true
## 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
- suspenders app --github organization/project
+ philosophies-suspenders app --github organization/project
This has the same effect as running:
hub create organization/project