From 59cea319ef8787db1577b85b217cf4dc2d586e47 Mon Sep 17 00:00:00 2001 From: Tommy Parnell Date: Sat, 2 May 2015 21:04:43 -0400 Subject: [PATCH] add readme docs --- README.md | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/README.md b/README.md index 8651533..c298d33 100644 --- a/README.md +++ b/README.md @@ -46,6 +46,17 @@ var t = new Repository().Get(ts); ``` +For Actions (usually post requests). Note: Actions return a dynamic object. Usually these responses are not needed, and you should still be able to use the dynamic object's data. If strong typed returns is required feel free to file an issue. However we don't predict people will really need to care about the returns of these actions. + + +```csharp + +var ts = new AuthenticatedUntappdCredentials("token", "key", "secret"); +var checkin = new CheckIn("-5", "EST", 1044097) { Shout = "Awesome Brew", Rating = 4 }; +var response = repository.Post(ts, checkin); + +``` + ## Contributing * Everyone is welcome to contribute!