summaryrefslogtreecommitdiff
path: root/rest-api-templates/README.txt
diff options
context:
space:
mode:
Diffstat (limited to 'rest-api-templates/README.txt')
-rw-r--r--rest-api-templates/README.txt15
1 files changed, 15 insertions, 0 deletions
diff --git a/rest-api-templates/README.txt b/rest-api-templates/README.txt
new file mode 100644
index 000000000..e927ad768
--- /dev/null
+++ b/rest-api-templates/README.txt
@@ -0,0 +1,15 @@
+This directory contains templates and template processing code for generating
+HTTP bindings for the RESTful API's.
+
+The RESTful API's are declared using [Swagger][swagger]. While Swagger provides
+a [code generating toolkit][swagger-codegen], it requires Java to run, which
+would be an unusual dependency to require for Asterisk developers.
+
+This code generator is similar, but written in Python. Templates are processed
+by using [pystache][pystache], which is a fairly simply Python implementation of
+[mustache][mustache].
+
+ [swagger]: https://github.com/wordnik/swagger-core/wiki
+ [swagger-codegen]: https://github.com/wordnik/swagger-codegen
+ [pystache]: https://github.com/defunkt/pystache
+ [mustache]: http://mustache.github.io/