README.markdown in btakita-screw-unit-server-0.3.0 vs README.markdown in btakita-screw-unit-server-0.6.0
- old
+ new
@@ -2,21 +2,32 @@
The Screw Unit ruby library is a server runner for the Screw Unit javascript library.
# Installing Screw Unit
You can use Screw Unit as a gem or as a Rails plugin.
To install the gem, run:
- sudo gem install screw_unit
+ sudo gem install pivotal-screw-unit-server
-To install the plugin, run:
- script/plugin install git://github.com/btakita/screw-unit-server.git
+To install the plugin with Rails 2.1.0:
+ script/plugin install git://github.com/pivotal/screw-unit-server.git
+
+To install the plugin with Rails <2.1.0:
+ cd vendor/plugins
+ git clone git://github.com/pivotal/screw-unit-server.git
+
+After installing screw unit server, run:
script/generate screw_unit
The Rails plugin gives you generators when using Screw Unit in a Rails environment.
# Running Screw Unit Server
-First you need to start your Screw Unit server.
+You can run the Screw Unit Server from the command line or via a Rails script.
+You can pass in the spec_file_path and public_path to the runner scripts,
+or by setting the SCREW_UNIT_SPEC_ROOT and SCREW_UNIT_PUBLIC environment variables.
+To run from the command line:
+ screw_unit_server [spec_file_path] [public_path]
+
If you are using screw_unit_server as a Rails plugin, you can simply run:
script/screw_unit_server
If you are using the screw_unit gem, you can run:
screw_unit_server /path/to/your/javascript/spec/files /path/to/your/javascript/implementation/files
@@ -31,11 +42,12 @@
To use Screw Unit in a CI environment,
* Install and run the selenium RC server on the machine that you want to run the browsers by using the command:
selenium
* Run the screw_unit_server on the machine that has the files.
script/screw_unit_server
- * Run the screw_unit client. The screw_unit client has --selenium_host, --selenium_port, and --spec_url arguments to specify
+ * Run the screw_unit client. The screw_unit client has --selenium_browser_start_command, --selenium_host, --selenium_port, and --spec_url arguments to specify
where the Selenium server is relative to the screw_unit server, and where the screw_unit server is relative to the browser.
+ * Running `script/screw_unit_server` is equivalent to running `script/screw_unit_server --selenium_browser_start_command *firefox --selenium_host localhost --selenium_port 4444 --spec_url http://localhost:8080/specs`
# Screw Unit Library
Screw.Unit is a Behavior-Driven Testing Framework for Javascript. It features nested describes. Its goals are to provide:
\ No newline at end of file