From 467ba8b9f954cab2dca28b9f5a3e7e98eb3d8ccd Mon Sep 17 00:00:00 2001 From: Vincent Fiduccia Date: Tue, 14 Jan 2014 17:28:06 -0700 Subject: [PATCH] Update README.md --- README.md | 14 +++++++++++--- 1 file changed, 11 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index acc9f7e..bbffb19 100644 --- a/README.md +++ b/README.md @@ -5,12 +5,20 @@ 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. +See [HTML UI](https://github.com/godaddy/gdapi/blob/master/specification.md#html-ui) in the API specification. + +Install +-------- +```bash +git clone https://github.com/godaddy/gdapi-ui +cd gdapi-ui +npm install +``` Usage -------- -### Compiling the stand-alone CSS and JavaScript files +### Compiling into stand-alone CSS and JavaScript files This will write files to ./compiled/{version}/, suitable for publishing to a CDN. ```bash @@ -39,7 +47,7 @@ app.get('/', function(req, res){ }); var assets = require('gd-assets'); -var groups = assets.groups.load(__dirname+'/assets.json'); +var groups = assets.groups.load('/path/to/gdapi-ui//assets.json'); assets.middleware(app, groups) app.listen(3000);