Permalink
Browse files

first bit of the readme

  • Loading branch information...
1 parent 6375451 commit 46c63d05956dc1c27ff85ee44b140e8ba1294543 @natritmeyer natritmeyer committed Apr 17, 2012
Showing with 34 additions and 0 deletions.
  1. +34 −0 README.md
View
@@ -0,0 +1,34 @@
+# SitePrism
+_A Page Object Model DSL for Capybara_
+
+SitePrism gives you a simple, clean and semantic DSL for describing your site using the Page Object Model pattern, for use with Capybara in automated acceptance testing. It encourages the "Page Object Model" pattern and makes it easy to do it well. One of its aims is to provide a pleasant syntax when using rspec/cucumber matchers and expectations.
+
+## Setup
+
+To install SitePrism:
+
+```bash
+gem install site_prism
+```
+
+If you are using cucumber, here's what needs requiring:
+
+```ruby
+require 'capybara'
+require 'capybara/dsl'
+require 'capybara/cucumber'
+require 'selenium-webdriver'
+require 'site_prism'
+```
+
+If you're using rspec instead, here's what needs requiring:
+
+```ruby
+require 'capybara'
+require 'capybara/dsl'
+require 'capybara/rspec'
+require 'selenium-webdriver'
+require 'site_prism'
+```
+
+

0 comments on commit 46c63d0

Please sign in to comment.