README.md in tcr-0.1.4 vs README.md in tcr-0.2.0
- old
+ new
@@ -4,11 +4,11 @@
TCR is a *very* lightweight version of [VCR](https://github.com/vcr/vcr) for TCP sockets.
-Currently used for recording 'net/smtp' interactions so only a few of the TCPSocket methods are recorded out.
+Currently used for recording 'net/smtp', 'net/imap' and 'net/ldap' interactions so only a few of the TCPSocket methods are recorded out.
## Installation
Add this line to your application's Gemfile:
@@ -85,9 +85,29 @@
```ruby
TCR.configure do |c|
c.hit_all = true
end
```
+
+The following storage formats are supported:
+
+- JSON (default)
+- YAML
+- Marshal (recommended for binary data transfer like LDAP)
+
+You can configure them via:
+
+```ruby
+TCR.configure do |c|
+ c.format = 'json'
+ # or
+ c.format = 'yaml'
+ # or
+ c.format = 'marshal'
+end
+```
+
+
## Contributing
1. Fork it
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -am 'Add some feature'`)