aboutsummaryrefslogtreecommitdiff
path: root/catapult/telemetry/third_party/web-page-replay/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'catapult/telemetry/third_party/web-page-replay/README.md')
-rw-r--r--catapult/telemetry/third_party/web-page-replay/README.md28
1 files changed, 28 insertions, 0 deletions
diff --git a/catapult/telemetry/third_party/web-page-replay/README.md b/catapult/telemetry/third_party/web-page-replay/README.md
new file mode 100644
index 00000000..28a3dc37
--- /dev/null
+++ b/catapult/telemetry/third_party/web-page-replay/README.md
@@ -0,0 +1,28 @@
+[![Build
+Status](https://travis-ci.org/chromium/web-page-replay.png)](https://travis-ci.org/chromium/web-page-replay)
+[![Coverage
+Status](https://coveralls.io/repos/chromium/web-page-replay/badge.svg)](https://coveralls.io/r/chromium/web-page-replay)
+
+# Web Page Replay
+Record live Web pages and use them for local performance testing!
+
+## How?
+Use local DNS and HTTP(S) proxies to captures your live traffic. Then
+use these captures in order to replay the same exact content, making
+sure that your tests get consistent results, that are not affected by
+the origin servers, the network, etc.
+
+## Tell me more
+Check out the [getting
+started](documentation/GettingStarted.md) guide or take a
+look at the [architecture
+diagram](documentation/WebPageReplayDiagram.png).
+
+Also see [Note about web-page-replay
+code](https://docs.google.com/document/d/1cehHn3Lig7UYw_7pqQJjkbPTV3kS11EYwjKO-6jT0c8)
+
+## I want to help
+If you find issues with the project, you can file issues on this repo.
+If you want to do more and contribute code to help the project evolve,
+check out our [contribution
+guidelines](documentation/Contributing.md).