From 3582d6804dcda43df4a46a862374ef5ea5efa05a Mon Sep 17 00:00:00 2001 From: zeke Date: Tue, 9 Aug 2011 12:28:46 -0700 Subject: [PATCH] Added a README --- README.md | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 00000000..aeeb405a --- /dev/null +++ b/README.md @@ -0,0 +1,22 @@ +Swagger UI +========== + +Swagger UI is a dependency-free collection of HTML, Javascript, and CSS assets that dynamically +generate beautiful documentation from a Swagger-compliant API. Because Swagger UI has no +dependencies, you can host it in any server environment, or on your local machine. + +Using It +-------- + +Using Swagger UI is simple. Download the + +Improving It +------------ + +1. [Fork!](https://github.com/wordnik/swagger-ui) +1. Hack. +1. Submit a pull request. + +Note: The HTML, CSS are compiled from Haml and Sass, which means there are currently a few development +dependencies. We are looking into revamping the source files to eliminate all development +dependencies. \ No newline at end of file