-
Notifications
You must be signed in to change notification settings - Fork 15.6k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
2 changed files
with
97 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,4 @@ | ||
|
||
=== 0.0.1 / YYYY-MM-DD | ||
|
||
* Initial release |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,93 @@ | ||
|
||
= Express | ||
|
||
Insanely fast (and small) server-side JavaScript web development framework | ||
built on node.js and the V8 JavaScript engine. | ||
|
||
* Stay tuned, coming soon :) | ||
|
||
== Features (so far) | ||
|
||
* Sexy DSL | ||
* Mime helpers | ||
* Nested parameter parsing | ||
* Full test coverage | ||
* Test helpers (mock requests etc) | ||
* Cookie support | ||
* Session support | ||
* Faux method support for RESTful apps | ||
* Extendable using Express 'Modules' | ||
* Static file serving | ||
* Non polluting so you can use it with your fav JavaScript libraries :) | ||
* Routing | ||
* string matching | ||
* regexp with captures | ||
* param key substitution | ||
* pre-conditions | ||
* overidding | ||
* etc | ||
|
||
== Coming Soon | ||
|
||
* View templating system | ||
* Jack integration | ||
|
||
== Examples | ||
|
||
// GET /user/tj/edit | ||
|
||
get('user/:name/:operation', function(){ | ||
param('operation') + 'ing ' + param('name') | ||
}) | ||
|
||
// GET /articles | ||
|
||
get('articles', function(){ | ||
'list of articles' | ||
}) | ||
|
||
// GET /articles/12 | ||
|
||
get(/articles\/(\d+)/, function(){ | ||
'article id ' + captures[1] | ||
}) | ||
|
||
// POST /user/:id | ||
|
||
post('user/:id', function(){ | ||
User.destroy(params('id')) ? | ||
'User deleted' : | ||
'Failed to delete user' | ||
}) | ||
|
||
== Headers | ||
|
||
get ('foo', function(){ | ||
header('Content-Type', 'text/html') | ||
'<p>bar</p>' | ||
}) | ||
|
||
== License | ||
|
||
(The MIT License) | ||
|
||
Copyright (c) 2009 TJ Holowaychuk <tj@vision-media.ca> | ||
|
||
Permission is hereby granted, free of charge, to any person obtaining | ||
a copy of this software and associated documentation files (the | ||
'Software'), to deal in the Software without restriction, including | ||
without limitation the rights to use, copy, modify, merge, publish, | ||
distribute, sublicense, and/or sell copies of the Software, and to | ||
permit persons to whom the Software is furnished to do so, subject to | ||
the following conditions: | ||
|
||
The above copyright notice and this permission notice shall be | ||
included in all copies or substantial portions of the Software. | ||
|
||
THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, | ||
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF | ||
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. | ||
IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY | ||
CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, | ||
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE | ||
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |