rancher
/
api-ui
mirror of https://github.com/rancher/api-ui.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Add link to spec for integrating with API

This commit is contained in:
Vincent Fiduccia 2013-03-18 11:48:39 -07:00
parent 0473a5c4c4
commit 0ce64ae394
1 changed files with 8 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
README.md
View File

@ -1,7 +1,11 @@
gdapi-ui gdapi-ui
======== ========
An in-browser client for Go Daddy® REST APIs An in-browser client for Go Daddy® REST API.
Integrating with your API
-------
See [HTML UI](https://github.com/godaddy/gdapi#html-ui) in the API specification.
Usage Usage
-------- --------
@ -14,7 +18,7 @@ This will write files to ./compiled/{version}/, suitable for publishing to a CDN
``` ```
### Standalone server ### Running as a standalone server
This will start a server on the given port number (default: 3000) that serves up the assets directly. This will start a server on the given port number (default: 3000) that serves up the assets directly.
This mode is mostly suitable for development of this library itself. This mode is mostly suitable for development of this library itself.
@ -22,7 +26,7 @@ This mode is mostly suitable for development of this library itself.
./serve [port] ./serve [port]
``` ```
### As part of another Node.js Connect/Express service ### Running as part of another Node.js Connect/Express service
This will add a route into your Connect/Express service to respond with the appropriate asset. This will add a route into your Connect/Express service to respond with the appropriate asset.
This mode is suitable for integrating with an existing project that already has a server running. This mode is suitable for integrating with an existing project that already has a server running.
```javascript ```javascript
@ -39,4 +43,4 @@ var groups = assets.groups.load(__dirname+'/assets.json');
assets.middleware(app, groups) assets.middleware(app, groups)
app.listen(3000); app.listen(3000);
``` ```