testing/webdriver/README.md

   1 webdriver library
   2 =================
   3
   4 The [webdriver crate] is a library implementation of the wire protocol
   5 for the [W3C WebDriver standard] written in Rust.  WebDriver is a remote
   6 control interface that enables introspection and control of user agents.
   7 It provides a platform- and language-neutral wire protocol as a way
   8 for out-of-process programs to remotely instruct the behaviour of web
   9 browsers.
  10
  11 The webdriver library provides the formal types, error codes, type and
  12 bounds checks, and JSON marshaling conventions for correctly parsing
  13 and emitting the WebDriver protocol.  It also provides an HTTP server
  14 where endpoints are mapped to the different WebDriver commands.
  15
  16 **As of right now, this is an implementation for the server side of the
  17 WebDriver API in Rust, not the client side.**
  18
  19 [webdriver crate]: https://crates.io/crates/webdriver
  20 [W3C WebDriver standard]: https://w3c.github.io/webdriver/
  21
  22
  23 Building
  24 ========
  25
  26 The library is built using the usual [Rust conventions]:
  27
  28         % cargo build
  29
  30 To run the tests:
  31
  32         % cargo test
  33
  34 [Rust conventions]: http://doc.crates.io/guide.html
  35
  36
  37 Contact
  38 =======
  39
  40 The mailing list for webdriver discussion is
  41 https://groups.google.com/a/mozilla.org/g/dev-webdriver.
  42
  43 There is also an Element channel to talk about using and developing
  44 webdriver on `#webdriver:mozilla.org <https://chat.mozilla.org/#/room/#webdriver:mozilla.org>`__