Permalink
Browse files

Remove extraneous parts in README, keep to quickstart and links to wiki

  • Loading branch information...
1 parent 813388c commit cbc4da9a81eef86dbf1343283a62c09b52572f6a @semperos committed Feb 21, 2012
Showing with 7 additions and 32 deletions.
  1. +7 −32 README.md
View
@@ -44,7 +44,7 @@ This library is compatible with *Clojure 1.3.0*.
### Quickstart ###
-Here's a complete example of how to log into Github:
+Here's a complete example of how to log into Github, using the high-level Taxi API:
```clj
(use 'clj-webdriver.taxi)
@@ -69,39 +69,10 @@ Forms can be filled out en masse using the `quick-fill-submit` function:
{"#password" submit})
```
-## API Documentation ##
+## Documentation ##
For API documentation on the high-level Taxi API (shown above), please [see its wiki page](https://github.com/semperos/clj-webdriver/wiki/Taxi%3A-Concise%2C-High-level-API).
-### Firefox Functionality
-
-**Note: This documentation is still valid, but refers to the lower-level core API for clj-webdriver.**
-
-Support for Firefox currently exceeds that for all other browsers, most notably via support for customizable Firefox profiles. I've included support for several of these advanced featues in the `clj-webdriver.firefox` namespace. Here are a few examples (borrowed from [here](http://code.google.com/p/selenium/wiki/RubyBindings):
-
-```clj
-(use 'clj-webdriver.core)
-(require '[clj-webdriver.firefox :as ff])
-
-(def b (new-driver {:browser :firefox,
- :profile (doto (ff/new-profile)
- ;; Enable Firebug
- (ff/enable-extension "/path/to/extensions/firebug.xpi")))
-
- ;; Auto-download certain file types to a specific folder
- (ff/set-preferences {:browser.download.dir "C:/Users/semperos/Desktop",
- :browser.download.folderList 2
- :browser.helperApps.neverAsk.saveToDisk "application/pdf"})}))
-```
-
-### Grid Support ###
-
-From a "user" perspective, working with Selenium-WebDriver's Grid 2 support behaves exactly like interacting with a locally-run RemoteWebDriver instance. See the `clj-webdriver.remote.server` and `clj-webdriver.remote.driver` namespaces for details on using this functionality.
-
-For information about configuring your Grid hub and nodes (which is handled at the command-line using the server-standalone jars), read [the Selenium-WebDriver wiki documentation on Grid 2](http://code.google.com/p/selenium/wiki/Grid2).
-
-## Documentation ##
-
For reference documentation, run `lein doc` at the root of this repo. For annotated source documentation, run `lein marg`.
## Contributing ##
@@ -114,7 +85,11 @@ If you want to fix a bug in the **current release**, please pull against the app
The namespace `clj-webdriver.test.example-app.core` contains a [Ring](https://github.com/mmcgrana/ring) app (routing by [Moustache](https://github.com/cgrand/moustache)) that acts as the "control application" for this project's test suite.
-Use `lein test` to run this library's test suite. Ensure port 5744 is free, or edit `test/clj_webdriver/test/core.clj` before running the tests. To run tests for the Taxi API, make sure you have the `lein-midje` plugin installed and run `lein midje clj-webdriver.test.taxi`.
+Use `lein test` to run this library's test suite. Ensure port 5744 is free, or edit `test/clj_webdriver/test/core.clj` before running the tests. To run tests for the Taxi API, make sure you have the `lein-midje` plugin installed and run:
+
+```
+lein midje clj-webdriver.test.taxi
+```
It is **highly** recommended that you run the test suite for each browser separately, as otherwise you will see strange errors. Each supported browser has its own namespace, for example:

0 comments on commit cbc4da9

Please sign in to comment.