Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Newer
Older
100644 102 lines (73 sloc) 2.968 kb
4957862 Write up the body of the readme.
Tim Caswell authored
1 # Connect
333145b @tj Added readme section for testing
tj authored
2
9370114 @tj more docs
tj authored
3 Connect is an extensible HTTP server framework for [node](http://nodejs.org), providing high performance "plugins" known as _middleware_.
b387688 @tj Authors
tj authored
4
c1b2643 @tj docs
tj authored
5 Connect is bundled with over _14_ commonly used middleware, including
b0070f2 @tj docs
tj authored
6 a logger, session support, cookie parser, and [more](http://senchalabs.github.com/connect). Be sure to view the 1.0 [documentation](http://senchalabs.github.com/connect/).
c1b2643 @tj docs
tj authored
7
8 ## 1.0 Migration Guide
9
9be16df @tj migration docs
tj authored
10 Connect 1.0 is a near-complete rewrite of Connect, with this
11 comes some changes, including some (minor) API changes,
12 and removal of a few middleware, which you are welcome to
13 rip out of previous versions as third-party middleware.
14
1170a5e @tj headers
tj authored
15 ### Middleware Removed
9be16df @tj migration docs
tj authored
16
17 - `cache` cached _everything_. This is less than ideal for dynamic apps, rendering this middleware relatively useless.
18 - `conditionalGet` blanketed _all_ requests, requiring the entire response to be computed before a response could be concluded. This is extremely wasteful.
19 - `staticGzip` useless. gzip / ship assets to a CDN
20 - `gzip` buggy
21 - `lint` lame
22
1170a5e @tj headers
tj authored
23 ### Middleware Renamed
9be16df @tj migration docs
tj authored
24
25 - `staticProvider` is now `static`
26 - `bodyDecoder` is now `bodyParser`
27 - `cookieDecoder` is now `cookieParser`
28
1170a5e @tj headers
tj authored
29 ### Middleware Added
9be16df @tj migration docs
tj authored
30
b9ba996 @tj docs
tj authored
31 - [limit](http://senchalabs.github.com/connect/middleware-limit.html)
32 - [profiler](http://senchalabs.github.com/connect/middleware-profiler.html)
33 - [responseTime](http://senchalabs.github.com/connect/middleware-responseTime.html)
b387688 @tj Authors
tj authored
34
70f909c @tj docs for connect()
tj authored
35 ### connect.createServer()
36
37 The `connect.createServer()` method is now optional, and equivalent to `connect()`. For example:
38
39 connect.createServer(
40 connect.logger()
41 , connect.static(__dirname)
42 ).listen(3000);
43
44 is the same as:
45
46 connect(
47 connect.logger()
48 , connect.static(__dirname)
49 ).listen(3000);
50
0466522 @tj docs for https
tj authored
51 When an options _object_ is passed as the first argument it is
52 assumed to be an https server:
53
54 connect({ options here }
55 connect.logger()
56 , connect.static(__dirname)
57 ).listen(443);
58
1bd1687 @tj test docs
tj authored
59 ## Running Tests
60
61 first:
62
63 $ git submodule update --init
64
65 then:
66
67 $ make test
68
b387688 @tj Authors
tj authored
69 ## Authors
70
71 Below is the output from [git-summary](http://github.com/visionmedia/git-extras).
72
73 project: connect
74 commits: 1408
75 files : 100
76 authors:
4c64d9f @tj add my commits together
tj authored
77 1184 Tj Holowaychuk
b387688 @tj Authors
tj authored
78 191 Tim Caswell
79 8 Astro
80 5 Nathan Rajlich
81 4 Jakub Nešetřil
82 2 Aaron Heckmann
83 2 Fabian Jakobs
84 2 Jacques Crocker
85 2 James Campos
86 1 Jakub Nesetril
87 1 Andreas Lind Petersen
88 1 Joshua Peek
89 1 Jxck
90 1 Gregory McWhirter
91 1 Eran Hammer-Lahav
92 1 Bart Teeuwisse
93 1 Guillermo Rauch
94e4ae5 @tj License
tj authored
94
b9b6051 @tj reformat history
tj authored
95 ## Node Compatibility
96
7ec42ba @tj versions
tj authored
97 Connect `< 1.0.0` is compatible with node 0.2.x
98 Connect `>= 1.0.0` is compatible with node 0.4.x
b9b6051 @tj reformat history
tj authored
99
94e4ae5 @tj License
tj authored
100 ## License
101
6be55d3 @tj license link
tj authored
102 View the [LICENSE](https://github.com/senchalabs/connect/blob/master/LICENSE) file.
Something went wrong with that request. Please try again.