Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

Starting to work on documentation

  • Loading branch information...
commit d6803cc1b8d1ae5a12982d498dc166ce1e17d824 1 parent e19d25c
@assaf authored
Showing with 62 additions and 22 deletions.
  1. +11 −0 CHANGELOG
  2. +9 −5 Cakefile
  3. +28 −10 README.md
  4. +14 −7 package.json
View
11 CHANGELOG
@@ -0,0 +1,11 @@
+Version 0.6.0 2010-12-20
+ First release that I could use to test an existing project.
+
+ Supports for navigation, filling and submitting forms, and selecting document
+ content using Sizzle. Browser features include evaluating JavaScript (jQuery,
+ Sammy.js), timers, XHR, cookies, local and session storage.
+
+ Still very rough around the edges.
+
+ 175 tests.
+ 1.8 sec to complete.
View
14 Cakefile
@@ -14,21 +14,25 @@ log = (message, color, explanation) ->
task "doc:source", "Builds source documentation", ->
log "Documenting source files", green
- exec "docco lib/**/*.coffee && mv -f docs/* html/ && rm -rf docs", (err) ->
- throw err if err
+ exec "docco lib/**/*.coffee && mv -f docs/* html/ && rm -rf docs", (err) -> throw err if err
task "doc:readme", "Build README file", ->
markdown = require("node-markdown").Markdown
fs.mkdir "html", 0777, ->
fs.readFile "README.md", "utf8", (err, text)->
- log "Writing html/index.html", green
- fs.writeFile "html/index.html", markdown(text), "utf8"
+ log "Creating html/index.html", green
+ exec "ronn --html README.md", (err, stdout, stderr)->
+ throw err if err
+ fs.writeFile "html/index.html", stdout, "utf8"
task "doc", "Generate documentation", ->
invoke "doc:readme"
invoke "doc:source"
-task "test", "Run all tests", -> exec "vows"
+task "test", "Run all tests", ->
+ exec "vows --spec", (err, stdout, stderr)->
+ console.log stdout
+ console.error stderr
task "clean", "Remove temporary files and such", ->
exec "rm -rf html"
View
38 README.md
@@ -21,25 +21,43 @@ Using
Coming.
-Selecting Elements
-------------------
+Feeding
+-------
-See the documentation for Sizzle.js:
-https://github.com/jeresig/sizzle/wiki
+See the documentation for [Sizzle.js](https://github.com/jeresig/sizzle/wiki).
+
+
+Bleeding Edge
+-------------
+
+For a full list of runtime dependencies, see [package.json](https://github.com/assaf/zombie/blob/master/package.json).
+
+The test suite requires [Vows 0.5.x](http://vowsjs.org/) and [Express 1.0.x](http://expressjs.com/):
+
+ $ npm install vows
+ $ npm install express
+ $ cake test
+
+For documentation you'll need [Ronn 0.3.x](https://github.com/kapouer/ronnjs) and [Docco 0.3](http://jashkenas.github.com/docco/):
+
+ $ npm install ronn
+ $ npm install docco
Contributing
------------
-Fork the project.
-Add tests.
-Make your changes.
-Send me a pull request.
+* Fork the project.
+* Add tests.
+* Make your changes.
+* Send me a pull request.
Brains
------
-Zombie.js is copyright of Assaf Arkin, released under the MIT License.
+Zombie.js is copyright of [Assaf Arkin](http://labnotes.org), released under the MIT License.
+
+Zombie.js is written in [CoffeeScript](http://jashkenas.github.com/coffee-script/).
-Sizzle.js is copyright of John Resig, released under the MIT, BSD and GPL.
+[Sizzle.js](http://sizzlejs.com/) is copyright of John Resig, released under the MIT, BSD and GPL.
View
21 package.json
@@ -12,11 +12,9 @@
],
"main": "./lib/zombie",
"directories": {
- "lib": "lib/zombie"
- },
- "repository": {
- "type": "git",
- "url": "https://assaf@github.com/assaf/zombie.git"
+ "doc": "./doc",
+ "lib": "./lib",
+ "man": "./man1"
},
"scripts": {
"build": "cake",
@@ -28,8 +26,17 @@
"dependencies": {
"coffee-script": ">= 0.9.6",
"htmlparser": ">= 1.7.3",
- "jquery": ">= 1.4.3",
"jsdom": ">= 0.1.21",
"vows": ">= 0.5.2"
- }
+ },
+ "repository": {
+ "type": "git",
+ "url": "https://assaf@github.com/assaf/zombie.git"
+ },
+ "licenses" : [
+ { "type" : "MIT",
+ "url" : "http://github.com/assaf/zombie/raw/master/MIT-LICENSE"
+ }
+ ]
+
}
Please sign in to comment.
Something went wrong with that request. Please try again.