diff options
Diffstat (limited to 'testing/webdriver/README.md')
| -rw-r--r-- | testing/webdriver/README.md | 44 |
1 files changed, 44 insertions, 0 deletions
diff --git a/testing/webdriver/README.md b/testing/webdriver/README.md new file mode 100644 index 0000000000..1eccdfd26c --- /dev/null +++ b/testing/webdriver/README.md @@ -0,0 +1,44 @@ +webdriver library +================= + +The [webdriver crate] is a library implementation of the wire protocol +for the [W3C WebDriver standard] written in Rust. WebDriver is a remote +control interface that enables introspection and control of user agents. +It provides a platform- and language-neutral wire protocol as a way +for out-of-process programs to remotely instruct the behaviour of web +browsers. + +The webdriver library provides the formal types, error codes, type and +bounds checks, and JSON marshaling conventions for correctly parsing +and emitting the WebDriver protocol. It also provides an HTTP server +where endpoints are mapped to the different WebDriver commands. + +**As of right now, this is an implementation for the server side of the +WebDriver API in Rust, not the client side.** + +[webdriver crate]: https://crates.io/crates/webdriver +[W3C WebDriver standard]: https://w3c.github.io/webdriver/ + + +Building +======== + +The library is built using the usual [Rust conventions]: + + % cargo build + +To run the tests: + + % cargo test + +[Rust conventions]: http://doc.crates.io/guide.html + + +Contact +======= + +The mailing list for webdriver discussion is +https://groups.google.com/a/mozilla.org/g/dev-webdriver. + +There is also an Element channel to talk about using and developing +webdriver on `#webdriver:mozilla.org <https://chat.mozilla.org/#/room/#webdriver:mozilla.org>`__ |