diff --git a/README.md b/README.md index 8c07539..970eaa0 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,27 @@ -Simple universal mocking tool for http requests +

what is it?

--set up expectations using json files in $PROJECT/everest directory --start using gradlew run --replay \ No newline at end of file +Simple universal mocking tool for http requests +- requires java 8 +- set up expectations using json files in $PROJECT/everest_data directory +-- or start java with -Deverest.data=[..] for a different data directory +- start using gradlew run +- replay + +

Sample json

+{
+"id": "91f83cd9-a0a5-49f5-b740-78ba8f504797",
+"name": "wehkamp.nl",
+"url": "http://www.wehkamp.nl",
+"method": "GET",
+"requestHeaders": {
+  "Accept": ["application/json"]
+  },
+"response": "",
+"responseStatus": 200
+}
+ +- url can be java regex expression + +

TODO's

+- implement response headers +- build a proxy that generates json