Skip to content

Commit

Permalink
added short doc section on editing tape files & why text bodies may s…
Browse files Browse the repository at this point in the history
…ometimes be recorded as binary
  • Loading branch information
robfletcher committed Sep 25, 2012
1 parent a9a47d8 commit 5339ae2
Showing 1 changed file with 11 additions and 1 deletion.
12 changes: 11 additions & 1 deletion src/docs/index.md
Expand Up @@ -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
Expand Down Expand Up @@ -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.
Expand Down

0 comments on commit 5339ae2

Please sign in to comment.