From 5339ae20684f875277f0acdb068db55cf302bfe6 Mon Sep 17 00:00:00 2001 From: Rob Fletcher Date: Tue, 25 Sep 2012 18:12:54 +0100 Subject: [PATCH] added short doc section on editing tape files & why text bodies may sometimes be recorded as binary --- src/docs/index.md | 12 +++++++++++- 1 file changed, 11 insertions(+), 1 deletion(-) diff --git a/src/docs/index.md b/src/docs/index.md index 379e1ed9..364b37b3 100644 --- a/src/docs/index.md +++ b/src/docs/index.md @@ -180,6 +180,10 @@ In such a case you can simply configure the `ignoreHosts` property of the `co.fr If you need to ignore connections to _localhost_ you can simply set the `ignoreLocalhost` property to `true`. +### Editing tape files + +Tape files are stored as _YAML_ so that they should be reasonably easy to edit by hand. HTTP request and response bodies are stored as text for most common textual MIME types. Binary data for things like images is also stored but is not practical to edit by hand. In some cases where the text contains non-printable characters then text data will be stored as binary. + ## Compatibility ### Apache HttpClient @@ -293,10 +297,16 @@ Betamax is a JVM port of the [VCR][vcr] library for Ruby. It is named after _[Be [Apache Software Licence, Version 2.0][licence] -### Authors +### Author Rob Fletcher [github][github] [twitter][twitter] [ad-hockery][adhockery] +### Contributors + +* [Marcin Erdmann](https://github.com/erdi) +* [Lari Hotari](https://github.com/lhotari) +* [Nobuhiro Sue](https://github.com/nobusue) + ### Issues Please raise issues on Betamax's [GitHub issue tracker][issues]. Forks and pull requests are more than welcome.