Skip to content

Commit

Permalink
update 3.0 docs
Browse files Browse the repository at this point in the history
  • Loading branch information
jonathanong committed Jan 5, 2014
1 parent ec30812 commit c0d4a7a
Show file tree
Hide file tree
Showing 3 changed files with 45 additions and 53 deletions.
1 change: 0 additions & 1 deletion .travis.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
language: node_js
node_js:
- "0.8"
- "0.10"
9 changes: 8 additions & 1 deletion History.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,11 @@
HEAD
3.0
===================

* move middleware to separate repos
* remove docs
* remove node patches

2.x
===================

* compress: use compressible
Expand Down
88 changes: 37 additions & 51 deletions Readme.md
Original file line number Diff line number Diff line change
@@ -1,83 +1,69 @@
# Connect [![build status](https://secure.travis-ci.org/senchalabs/connect.png)](http://travis-ci.org/senchalabs/connect)

Connect is an extensible HTTP server framework for [node](http://nodejs.org), providing high performance "plugins" known as _middleware_.

Connect is bundled with over _20_ commonly used middleware, including
a logger, session support, cookie parser, and [more](http://senchalabs.github.com/connect). Be sure to view the 2.x [documentation](http://www.senchalabs.org/connect/).
Connect is an extensible HTTP server framework for [node](http://nodejs.org) using "plugins" known as _middleware_.

```js
var connect = require('connect')
, http = require('http');

var app = connect()
.use(connect.favicon())
.use(connect.logger('dev'))
.use(connect.static('public'))
.use(connect.directory('public'))
.use(connect.cookieParser())
.use(connect.session({ secret: 'my secret here' }))
.use(require('compression')())
.use(require('')())
.use(require('')())
.use(function(req, res){
res.end('Hello from Connect!\n');
});

http.createServer(app).listen(3000);
```

## Middleware

- [basicAuth](http://www.senchalabs.org/connect/basicAuth.html)
- [bodyParser](http://www.senchalabs.org/connect/bodyParser.html)
- [compress](http://www.senchalabs.org/connect/compress.html)
- [cookieParser](http://www.senchalabs.org/connect/cookieParser.html)
- [cookieSession](http://www.senchalabs.org/connect/cookieSession.html)
- [csrf](http://www.senchalabs.org/connect/csrf.html)
- [directory](http://www.senchalabs.org/connect/directory.html)
- [errorHandler](http://www.senchalabs.org/connect/errorHandler.html)
- [favicon](http://www.senchalabs.org/connect/favicon.html)
- [json](http://www.senchalabs.org/connect/json.html)
- [limit](http://www.senchalabs.org/connect/limit.html)
- [logger](http://www.senchalabs.org/connect/logger.html)
- [methodOverride](http://www.senchalabs.org/connect/methodOverride.html)
- [multipart](http://www.senchalabs.org/connect/multipart.html)
- [urlencoded](http://www.senchalabs.org/connect/urlencoded.html)
- [query](http://www.senchalabs.org/connect/query.html)
- [responseTime](http://www.senchalabs.org/connect/responseTime.html)
- [session](http://www.senchalabs.org/connect/session.html)
- [static](http://www.senchalabs.org/connect/static.html)
- [staticCache](http://www.senchalabs.org/connect/staticCache.html)
- [subdomains](http://www.senchalabs.org/connect/subdomains.html)
- [vhost](http://www.senchalabs.org/connect/vhost.html)

## Running Tests

first:
## Connect 3.0

$ npm install -d
Connect 3.0 is in progress in the `master` branch. The main changes in Connect are:

then:
- Middleware will be moved to their own repositories in the [expressjs](http://github.com/expressjs) organization
- All node patches will be removed - all middleware _should_ work without Connect and with similar frameworks like [restify](https://github.com/mcavage/node-restify)
- Node `0.8` is no longer supported
- The website documentation has been removed - view the markdown readmes instead

$ make test

## Contributors
If you would like to help maintain these middleware, please contact [@jongleberry](https://twitter.com/jongleberry).

https://github.com/senchalabs/connect/graphs/contributors
## Middleware

## Node Compatibility
These middleware are officially supported by the Connect/Express team:

Connect `< 1.x` is compatible with node 0.2.x
- [compression](https://github.com/expressjs/compression) - previously `compress`

These middleware previously included with Connect are no longer supported by the Connect/Express team. Use one of these alternatives intead:

Connect `1.x` is compatible with node 0.4.x
- `cookieParser`
- [cookies](https://github.com/jed/cookies) and [keygrip](https://github.com/jed/keygrip)
- `limit`
- [raw-body](https://github.com/stream-utils/raw-body)
- `multipart`
- [connect-multiparty](https://github.com/superjoe30/connect-multiparty)
- [connect-busboy](https://github.com/mscdex/connect-busboy)
- `staticCache`
- [st](https://github.com/isaacs/st)

## Running Tests

Connect `2.x` is compatible with node 0.6.x
```bash
npm install
make test
```

## Contributors

Connect (_master_) is compatible with node 0.8.x
https://github.com/senchalabs/connect/graphs/contributors

## CLA
## Node Compatibility

[http://sencha.com/cla](http://sencha.com/cla)
- Connect `< 1.x` - node `0.2`
- Connect `1.x` - node `0.4`
- Connect `< 2.8` - node `0.6`
- Connect `>= 2.8 < 3` - node `0.8`
- Connect `>= 3` - node `0.10`

## License

Expand Down

0 comments on commit c0d4a7a

Please sign in to comment.