From 9f4ae7b36fad905fa74a878bdc2180add99d6c35 Mon Sep 17 00:00:00 2001 From: Kevin McCarthy Date: Sun, 11 Aug 2013 18:51:29 -1000 Subject: [PATCH] update readme --- README.md | 15 ++++++++++----- 1 file changed, 10 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 5a57171..df93768 100644 --- a/README.md +++ b/README.md @@ -1,17 +1,22 @@ #VCR.py -This is a start at a Python version of [Ruby's VCR library](https://github.com/myronmarston/vcr). +This is a Python version of [Ruby's VCR library](https://github.com/myronmarston/vcr). [![Build Status](https://secure.travis-ci.org/kevin1024/vcrpy.png?branch=master)](http://travis-ci.org/kevin1024/vcrpy) -##What it is supposed to do +##What it does Simplify testing by recording all HTTP interactions and saving them to -"cassette" files, which are just yaml files. Then when you run your tests -again, they all just hit the text files instead of the internet. This speeds up +"cassette" files, which are yaml files containing the contents of your +requests and responses. Then when you run your tests again, they all +just hit the text files instead of the internet. This speeds up your tests and lets you work offline. +If the server you are testing against ever changes its API, all you need +to do is delete your existing cassette files, and run your tests again. +All of the mocked responses will be updated with the new API. + ##Compatibility Notes -This should work with Python 2.6 and 2.7. It also seems to work with [pypy](http://pypy.org). +This should work with Python 2.6 and 2.7, and [pypy](http://pypy.org). Currently I've only tested this with urllib2, urllib3, and requests. It's known to *NOT WORK* with urllib.