Gussied up the README
This commit is contained in:
35
README.md
35
README.md
@@ -5,18 +5,37 @@ Swagger UI is a dependency-free collection of HTML, Javascript, and CSS assets t
|
||||
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
|
||||
--------
|
||||
How to Use It
|
||||
-------------
|
||||
|
||||
Using Swagger UI is simple. Download the
|
||||
```bash
|
||||
wget https://github.com/downloads/wordnik/swagger-ui/swagger-ui-1.0.zip
|
||||
unzip swagger-ui-1.0.zip
|
||||
open swagger-ui-1.0/index.html
|
||||
```
|
||||
|
||||
Improving It
|
||||
------------
|
||||
How to Improve 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.
|
||||
Note: The HTML and CSS are converted from Haml and Sass, which means there are currently some development
|
||||
dependencies. We are looking into revamping the source files and eliminating all development
|
||||
dependencies by using [less.js](http://lesscss.org/)
|
||||
|
||||
License
|
||||
-------
|
||||
|
||||
Copyright 2011 Wordnik, Inc.
|
||||
|
||||
Licensed under the Apache License, Version 2.0 (the "License");
|
||||
you may not use this file except in compliance with the License.
|
||||
You may obtain a copy of the License at [apache.org/licenses/LICENSE-2.0](http://www.apache.org/licenses/LICENSE-2.0)
|
||||
|
||||
Unless required by applicable law or agreed to in writing, software
|
||||
distributed under the License is distributed on an "AS IS" BASIS,
|
||||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
See the License for the specific language governing permissions and
|
||||
limitations under the License.
|
||||
|
||||
Reference in New Issue
Block a user