README.md in daiku-0.1.0 vs README.md in daiku-0.1.1

- old
+ new

@@ -21,42 +21,53 @@ $ cd myapp $ bundle install $ bundle exec foreman start $ open http://localhost:5000 + +Or as a oneliner: + + daiku new myapp --port 5000 && cd myapp && bundle install && bundle exec foreman start + +Then visit `http://localhost:5000` in your browser. + ### Options You can further customize the app that's generated by passing additional options. The built-in help system explains the available options. $ daiku help new Usage: daiku new APP -p, --port=N Options: - -p, --port=N # Port this app should run on locally. - [--ruby-version=RUBY_VERSION] # Specify the version of ruby this project should use. - # Default: 2.1.2 - -m, [--models=MODELS] # Choose the data modeling tool this project uses. - # Default: datamapper - # Possible values: datamapper, none - -a, [--assets=ASSETS] # Choose the assets workflow this project uses. - # Default: grunt - # Possible values: grunt, none - [--honeybadger-private-key=HONEYBADGER-PRIVATE-KEY] # Honeybadger Private API Key - [--honeybadger-public-key=HONEYBADGER-PUBLIC-KEY] # Honeybadger Private API Key - [--no-newrelic] # Don't use New Relic. - [--with-vcr] # Include `vcr` in this project's TDD stack. - [--with-sidekiq] # Set this project up to use `sidekiq` for background processing. + -p, --port=N # Port this app should run on locally. + [--ruby=RUBY] # Specify the version of ruby this project should use. + # Default: 2.1.5 + [--node=NODE] # Specify the version of node this project should use (for grunt, etc). + # Default: v0.10.33 + -a, [--assets=ASSETS] # Choose the assets workflow this project uses. + # Possible values: grunt + -e, [--errors=ERRORS] # Choose the error reporting lib this project uses. + # Possible values: honeybadger + -j, [--jobs=JOBS] # Choose the background jobs lib this project uses. + # Possible values: sidekiq + -m, [--models=MODELS] # Choose the data modeling lib this project uses. + # Possible values: datamapper + -M, [--monitors=MONITORS] # Choose the monitoring lib this project uses. + # Possible values: newrelic + [--vcr] # Include `vcr` in this project's BDD stack? + [--sql] # SQL or No-SQL? If SQL, assumes postgresql + # Default: true + [--version] -Generate a new application with daiku + Generate a new application with daiku - ### Example Consider the following example: - $ daiku new myapp -p 5000 -m datamapper -a grunt --with-vcr --with-sidekiq + $ daiku new myapp --port 5000 --models datamapper --assets grunt --errors honeybadger --monitors newrelic --jobs sidekiq --vcr This will generate the following app: ```` myapp @@ -93,11 +104,11 @@ ├── bin │   └── console ├── bower.json ├── config │   ├── datamapper.rb -│   ├── honeybadger.rb +│   ├── pony.rb │   ├── puma.rb │   └── sidekiq.rb ├── config.ru ├── lib │   ├── boot.rb @@ -118,9 +129,10 @@ │   └── .gitkeep ├── package.json ├── public │   ├── assets │   │   └── .gitkeep +│   ├── favicon.ico │   └── fonts │   └── .gitkeep ├── spec │   ├── _cassettes │   │   └── .gitkeep