docs(readme): usage inforamtion, incl. auth.gif

dermesser · Feb 27, 2015 · 40c9a0a · 40c9a0a
1 parent 00e3f5f
commit 40c9a0a
Show file tree

Hide file tree

Showing 3 changed files with 17 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -4,4 +4,20 @@
 
 It is implemented such that it makes no assumptions about the front-end, allowing more uses than just in yup.
 
-Architecturally, it may never be implementing more than device authentication, yet is set up not to constrain itself.
+Architecturally, it may never be implementing more than device authentication, yet is set up not to constrain itself.
+
+### Usage
+
+Please have a look at the [API landing page][API-docs] for all the examples you will ever need.
+
+A simple commandline program which authenticates any scope and prints token information can be found in [the examples directory][examples].
+
+The video below shows the *auth* example in action. It's meant to be used as utility to record all server communication and improve protocol compliance.
+
+![usage][auth-usage]
+
+
+[API-docs]: http://byron.github.io/yup-oauth2
+[examples]: https://github.com/Byron/yup-oauth2/tree/master/examples
+[auth-usage]: https://raw.githubusercontent.com/Byron/yup-oauth2/master/examples/auth.rs-usage.gif
+
diff --git a/examples/auth.rs-usage.gif b/examples/auth.rs-usage.gif
diff --git a/examples/auth.rs-usage.ttyrec b/examples/auth.rs-usage.ttyrec