README.md in embork-0.0.4 vs README.md in embork-0.0.5
- old
+ new
@@ -1,25 +1,48 @@
# Embork
-TODO: Write a gem description
+Build awesome hybrid EmberJS Apps! Embork is a build system for ember backed by
+sprockets. It works like any conventional build system, but with a focus on
+supporting multiple build targets. It also has a facility to develop with a
+rack-compatible back-end providing the index.html file.
## Installation
-Add this line to your application's Gemfile:
+Install it as a gem!
- gem 'embork'
+ $ gem install embork
-And then execute:
+## Usage
- $ bundle
+#### To create a new application:
-Or install it yourself as:
+ $ embork new my-app
- $ gem install embork
+#### Running the development server:
-## Usage
+ $ embork server <environment>
-TODO: Write usage instructions here
+The default environment is 'development'. There is also a production environment
+included with the generator, however, you may create as many environments as you
+want just by copying or creating a new folder under the `config` directory.
+
+#### Running the test suite
+
+There are two ways to run tests. You can run the QUnit test suite in a browser
+by running the test server with the test paths enabled:
+
+ $ embork server --enable-tests <environment>
+ $ open http://localhost:9292/tests.html
+
+You can also run the test suite entirely via the command line:
+
+ $ embork test <environment>
+
+This will run a server on a random port, and connect to it using the
+`qunit-runner` [gem](https://github.com/scoremedia/qunit-runner "qunit-runner").
+This is the best option to use for integrating QUnit into your ci server.
+Additionally, you can use the `DISABLE_COLORS` environment variable to turn off
+colour in stdout. This helps with ci servers that don't support tty color.
## Contributing
1. Fork it
2. Create your feature branch (`git checkout -b my-new-feature`)