mirror of https://github.com/rancher/api-ui.git
Add link to spec for integrating with API
This commit is contained in:
parent
0473a5c4c4
commit
0ce64ae394
12
README.md
12
README.md
|
|
@ -1,7 +1,11 @@
|
|||
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
|
||||
--------
|
||||
|
|
@ -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 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]
|
||||
```
|
||||
|
||||
### 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 mode is suitable for integrating with an existing project that already has a server running.
|
||||
```javascript
|
||||
|
|
@ -39,4 +43,4 @@ var groups = assets.groups.load(__dirname+'/assets.json');
|
|||
assets.middleware(app, groups)
|
||||
|
||||
app.listen(3000);
|
||||
```
|
||||
```
|
||||
|
|
|
|||
Loading…
Reference in New Issue