Added a README

This commit is contained in:
zeke
2011-08-09 12:28:46 -07:00
parent f738ca4732
commit 3582d6804d

22
README.md Normal file
View File

@@ -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.