kyy/swagger-ui
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

update README

Browse Source
This commit is contained in:
Filirom1
2013-01-23 17:22:18 +01:00
parent baab722d64
commit 8669ad1018
1 changed files with 7 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
README.md
View File

@@ -18,10 +18,9 @@ unpack and start using it. If you like swagger-ui as-is, stop here.
### Build ### Build
You can rebuild swagger-ui on your own to tweak it or just so you can say you did. To do so, follow these steps: You can rebuild swagger-ui on your own to tweak it or just so you can say you did. To do so, follow these steps:
1. Install [CoffeeScript](http://coffeescript.org/#installation) which will give you [cake](http://coffeescript.org/#cake) 1. npm install
2. Install [handlebars](http://handlebarsjs.com/) using 'npm install handlebars -g' 2. npm run-script build
3. Run cake dist 3. You should see the distribution under the dist folder. Open ./dist/index.html to launch Swagger UI in a browser
4. You should see the distribution under the dist folder. Open ./dist/index.html to launch Swagger UI in a browser
### Use ### Use
Once you open the Swagger UI, it will load the [Swagger Petstore](http://petstore.swagger.wordnik.com/api/resources.json) service and show its APIs. Once you open the Swagger UI, it will load the [Swagger Petstore](http://petstore.swagger.wordnik.com/api/resources.json) service and show its APIs.