Permalink
Browse files

Use yuidocjs build tool for `make html`.

  • Loading branch information...
1 parent f65c1f6 commit 01ef719de7b91b271ea03b7d39249e0808c79c57 @reid committed Mar 3, 2012
Showing with 19 additions and 1 deletion.
  1. +1 −0 .gitignore
  2. +1 −0 .npmignore
  3. +4 −0 Makefile
  4. +11 −0 README.md
  5. +2 −1 package.json
View
@@ -1,3 +1,4 @@
+api
tools
coverage.*
node_modules
View
@@ -1,3 +1,4 @@
+api
tools
coverage.*
.git*
View
@@ -12,6 +12,10 @@ spec:
coverage:
sh scripts/coverage.sh
+html:
+ ./node_modules/.bin/yuidoc
+.PHONY: html
+
install:
npm install .
.PHONY: install
View
@@ -122,6 +122,17 @@ Installing [localtunnel][] helps proxy Yeti outside of your firewall. It's avail
$ gem install localtunnel
+## Yeti API
+
+You can `require("yeti")` inside your application to script Yeti for your own use.
+
+For API documentation:
+
+ - Run `make html` to build HTML documentation to `./api`.
+ - Review code comments inside `lib/yeti.js`, `lib/client.js` and `lib/hub/index.js`.
+
+Yeti follows [Semantic Versioning](http://semver.org/) but is currently at a 0.x.y release. **The public API is not stable.** There will be changes.
+
## Testing
First, install the latest [PhantomJS][] for your platform. With [Homebrew][], just run `brew update; brew install phantomjs`.
View
@@ -56,6 +56,7 @@
"jslint": ">=0.1.4",
"pact": ">=0.1.2",
"phantom": ">=0.3.3",
- "vows": ">=0.5.0"
+ "vows": ">=0.5.0",
+ "yuidocjs": ">=0.2.26"
}
}

0 comments on commit 01ef719

Please sign in to comment.