README.md in venom-0.0.4 vs README.md in venom-0.0.5
- old
+ new
@@ -1,8 +1,8 @@
# Venom
-TODO: Write a gem description
+The goal of Venom is to provide a project structure for using Symbiont, Watir-WebDriver, and Cucumber.
## Installation
Add this line to your application's Gemfile:
@@ -16,10 +16,28 @@
$ gem install venom
## Usage
-TODO: Write usage instructions here
+The easiest way to use Venom would be to have it generate the default structure for you:
+
+ $ venom workshop project-spec
+
+This command will create a workshop (project) structure with the directory name as project-spec. You can also indicate that you want a separate library (which I recommend).
+
+ $ venom workshop project-spec --library
+
+What this does is allow the project to have a separate library (lib) directory. The reason you might do this is to keep your specifications (feature files) separate from various aspects of implementation.
+
+You can also indicate that you want the browser to restart after every scenario is executed.
+
+ $ venom workshop project-spec --restart
+
+This is as opposed to using the same browser for the entire feature file.
+
+You can, of course, chain these options together.
+
+ $ venom workshop project-spec --library --restart
## Contributing
1. Fork it
2. Create your feature branch (`git checkout -b my-new-feature`)