raspberryGPIOhtmlserver/node_modules/connect/Readme.md
node_modules/connect/Readme.mdRaw
1[](http://travis-ci.org/senchalabs/connect)
2# Connect
3
4 Connect is an extensible HTTP server framework for [node](http://nodejs.org), providing high performance "plugins" known as _middleware_.
5
6 Connect is bundled with over _20_ commonly used middleware, including
7 a logger, session support, cookie parser, and [more](http://senchalabs.github.com/connect). Be sure to view the 2.x [documentation](http://senchalabs.github.com/connect/).
8
9```js
10var connect = require('connect')
11 , http = require('http');
12
13var app = connect()
14 .use(connect.favicon())
15 .use(connect.logger('dev'))
16 .use(connect.static('public'))
17 .use(connect.directory('public'))
18 .use(connect.cookieParser())
19 .use(connect.session({ secret: 'my secret here' }))
20 .use(function(req, res){
21 res.end('Hello from Connect!\n');
22 });
23
24http.createServer(app).listen(3000);
25```
26
27## Middleware
28
29 - [csrf](http://www.senchalabs.org/connect/csrf.html)
30 - [basicAuth](http://www.senchalabs.org/connect/basicAuth.html)
31 - [bodyParser](http://www.senchalabs.org/connect/bodyParser.html)
32 - [json](http://www.senchalabs.org/connect/json.html)
33 - [multipart](http://www.senchalabs.org/connect/multipart.html)
34 - [urlencoded](http://www.senchalabs.org/connect/urlencoded.html)
35 - [cookieParser](http://www.senchalabs.org/connect/cookieParser.html)
36 - [directory](http://www.senchalabs.org/connect/directory.html)
37 - [compress](http://www.senchalabs.org/connect/compress.html)
38 - [errorHandler](http://www.senchalabs.org/connect/errorHandler.html)
39 - [favicon](http://www.senchalabs.org/connect/favicon.html)
40 - [limit](http://www.senchalabs.org/connect/limit.html)
41 - [logger](http://www.senchalabs.org/connect/logger.html)
42 - [methodOverride](http://www.senchalabs.org/connect/methodOverride.html)
43 - [query](http://www.senchalabs.org/connect/query.html)
44 - [responseTime](http://www.senchalabs.org/connect/responseTime.html)
45 - [session](http://www.senchalabs.org/connect/session.html)
46 - [static](http://www.senchalabs.org/connect/static.html)
47 - [staticCache](http://www.senchalabs.org/connect/staticCache.html)
48 - [vhost](http://www.senchalabs.org/connect/vhost.html)
49 - [subdomains](http://www.senchalabs.org/connect/subdomains.html)
50 - [cookieSession](http://www.senchalabs.org/connect/cookieSession.html)
51
52## Running Tests
53
54first:
55
56 $ npm install -d
57
58then:
59
60 $ make test
61
62## Authors
63
64 Below is the output from [git-summary](http://github.com/visionmedia/git-extras).
65
66
67 project: connect
68 commits: 2033
69 active : 301 days
70 files : 171
71 authors:
72 1414 Tj Holowaychuk 69.6%
73 298 visionmedia 14.7%
74 191 Tim Caswell 9.4%
75 51 TJ Holowaychuk 2.5%
76 10 Ryan Olds 0.5%
77 8 Astro 0.4%
78 5 Nathan Rajlich 0.2%
79 5 Jakub Nešetřil 0.2%
80 3 Daniel Dickison 0.1%
81 3 David Rio Deiros 0.1%
82 3 Alexander Simmerl 0.1%
83 3 Andreas Lind Petersen 0.1%
84 2 Aaron Heckmann 0.1%
85 2 Jacques Crocker 0.1%
86 2 Fabian Jakobs 0.1%
87 2 Brian J Brennan 0.1%
88 2 Adam Malcontenti-Wilson 0.1%
89 2 Glen Mailer 0.1%
90 2 James Campos 0.1%
91 1 Trent Mick 0.0%
92 1 Troy Kruthoff 0.0%
93 1 Wei Zhu 0.0%
94 1 comerc 0.0%
95 1 darobin 0.0%
96 1 nateps 0.0%
97 1 Marco Sanson 0.0%
98 1 Arthur Taylor 0.0%
99 1 Aseem Kishore 0.0%
100 1 Bart Teeuwisse 0.0%
101 1 Cameron Howey 0.0%
102 1 Chad Weider 0.0%
103 1 Craig Barnes 0.0%
104 1 Eran Hammer-Lahav 0.0%
105 1 Gregory McWhirter 0.0%
106 1 Guillermo Rauch 0.0%
107 1 Jae Kwon 0.0%
108 1 Jakub Nesetril 0.0%
109 1 Joshua Peek 0.0%
110 1 Jxck 0.0%
111 1 AJ ONeal 0.0%
112 1 Michael Hemesath 0.0%
113 1 Morten Siebuhr 0.0%
114 1 Samori Gorse 0.0%
115 1 Tom Jensen 0.0%
116
117## Node Compatibility
118
119 Connect `< 1.x` is compatible with node 0.2.x
120
121
122 Connect `1.x` is compatible with node 0.4.x
123
124
125 Connect (_master_) `2.x` is compatible with node 0.6.x
126
127## CLA
128
129 [http://sencha.com/cla](http://sencha.com/cla)
130
131## License
132
133View the [LICENSE](https://github.com/senchalabs/connect/blob/master/LICENSE) file. The [Silk](http://www.famfamfam.com/lab/icons/silk/) icons used by the `directory` middleware created by/copyright of [FAMFAMFAM](http://www.famfamfam.com/).