Skip to content

Commit

Permalink
Updated documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
shimaore committed Apr 17, 2012
1 parent 3d020fb commit 3498865
Show file tree
Hide file tree
Showing 3 changed files with 14 additions and 8 deletions.
7 changes: 6 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
**v0.3.4** (2012-04-16):

- Publishing as `zappajs`.
- Workaround for express 3.0.0alpha1.

**v0.3.3** (2011-11-22):

- Fixed npm publishing error.
Expand Down Expand Up @@ -114,4 +119,4 @@

**v0.1.0 "Jazz from Hell"** (2010-10-21):

- Initial release.
- Initial release.
1 change: 1 addition & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
Copyright (c) 2010 Maurice Machado <maurice@bitbending.com>
Copyright (c) 2012 Stephane Alnet <stephane@shimaore.net>

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand Down
14 changes: 7 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ If you can describe it in 495 characters, why on earth should it take 879?
Zappa is a [CoffeeScript](http://coffeescript.org)-optimized interface to [Express](http://expressjs.com) and [Socket.IO](http://socket.io) that makes this:

```coffee
require('zappa') ->
require('zappajs') ->
Gizmo = require './model/gizmo'

@use 'bodyParser', 'methodOverride', @app.router, 'static'
Expand Down Expand Up @@ -78,7 +78,7 @@ console.log "Express server listening on port %d in %s mode",
And throws in some additional features while at it:

```coffee
require('zappa') ->
require('zappajs') ->
@enable 'default layout', 'serve jquery',
'serve sammy', 'minify'

Expand Down Expand Up @@ -115,21 +115,21 @@ require('zappa') ->

- Check the [API reference](http://zappajs.org/docs/0.3-gumbo/reference)

- See the [examples](https://github.com/mauricemach/zappa/tree/master/examples) included with the source
- See the [examples](https://github.com/shimaore/zappajs/tree/master/examples) included with the source

- Read the [annotated source](http://zappajs.org/docs/zappa.html) generated by [docco](http://jashkenas.github.com/docco/)

## Other resources

- The source code [repository](http://github.com/mauricemach/zappa) at github
- The source code [repository](http://github.com/shimaore/zappajs) at github

- Questions, suggestions? Drop us a line on the [mailing list](http://groups.google.com/group/zappajs)

- Rather do it realtime? Join the IRC channel on freenode: [#zappajs]((irc://irc.freenode.net/zappajs)

- Found a bug? Open an [issue](http://github.com/mauricemach/zappa/issues) at github
- Found a bug? Open an [issue](http://github.com/shimaore/zappajs/issues) at github

- Check the project's history at the [change log](https://github.com/mauricemach/zappa/blob/master/CHANGELOG.md)
- Check the project's history at the [change log](https://github.com/shimaore/zappajs/blob/master/CHANGELOG.md)

- Migrating from an earlier version? Read the announcements ([0.2.x](http://zappajs.org/docs/0.2-peaches/announcement)/[0.3.x](http://zappajs.org/docs/0.3-gumbo/announcement)) for an overview on changes, and follow the TL;DR migration guides ([0.2.x](http://zappajs.org/docs/0.2-peaches/migration)/[0.3.x](http://zappajs.org/docs/0.3-gumbo/migration))

Expand All @@ -155,4 +155,4 @@ Also:

- And last but not least Frank Zappa, for the spirit of nonconformity and experimentation that inspires me to push forward. Not to mention providing the soundtrack.

"Why do you necessarily have to be wrong just because a few million people think you are?" - FZ
"Why do you necessarily have to be wrong just because a few million people think you are?" - FZ

0 comments on commit 3498865

Please sign in to comment.