README.md in lucid-0.0.1 vs README.md in lucid-0.0.2

- old
+ new

@@ -1,9 +1,13 @@ # Lucid -Lucid is a Test Description Language (TDL) execution engine, similar to tools like Cucumber, Spinach, or Turnip, but without a name based on food. +Lucid is a shiv around BDD tools. Currently the only such tool that Lucid intercepts calls to is Cucumber. The reason for this is that many of these BDD tools are highly opinionated in their structure. While most tools do have a way to force the structure to be your way, how this is done is not always consistent. +By way of example, Cucumber expects features to live in a directory called features and step definitions to live in a directory called step_definitions that is under the features directory. When running a feature, all step definitions are loaded unless you explicitly require just the ones you want. If you structure your project differently from how Cucumber expects, then you have to require files explicitly. + +Lucid allows you to specify configuration options that are then passed to Cucumber. + ## Installation Add this line to your application's Gemfile: gem 'lucid' @@ -16,16 +20,14 @@ $ gem install lucid ## Usage -Instructions on usage will follow when I have an actual implementation. +Lucid can be configured project by project through the use of a lucid.yml file that lives in the root of your project. This file will contain configurable options. These options will be indicated by specific declarations. ## Contributing -You can contribute to the development of Lucid. - -1. Fork the project. -2. Create your feature branch (`git checkout -b my-new-feature`). -3. Commit your changes (`git commit -am 'Add some feature'`). -4. Push to the branch (`git push origin my-new-feature`). -5. Create new Pull Request. +1. Fork it +2. Create your feature branch (`git checkout -b my-new-feature`) +3. Commit your changes (`git commit -am 'Add some feature'`) +4. Push to the branch (`git push origin my-new-feature`) +5. Create new Pull Request