From 5f7a37ee517e172c0762fc3debaf94c066e531f9 Mon Sep 17 00:00:00 2001 From: Fishrock123 Date: Sat, 11 Oct 2014 14:12:03 -0400 Subject: [PATCH] docs: misc. tweaks closes #2394 --- Readme.md | 97 +++++++++++++++++++++++++++++-------------------------- 1 file changed, 52 insertions(+), 45 deletions(-) diff --git a/Readme.md b/Readme.md index 426bb723..8dacd469 100644 --- a/Readme.md +++ b/Readme.md @@ -2,10 +2,10 @@ Fast, unopinionated, minimalist web framework for [node](http://nodejs.org). - [![NPM Version](https://img.shields.io/npm/v/express.svg?style=flat)](https://www.npmjs.org/package/express) - [![Build Status](https://img.shields.io/travis/strongloop/express.svg?style=flat)](https://travis-ci.org/strongloop/express) - [![Coverage Status](https://img.shields.io/coveralls/strongloop/express.svg?style=flat)](https://coveralls.io/r/strongloop/express) - [![Gittip](https://img.shields.io/gittip/dougwilson.svg?style=flat)](https://www.gittip.com/dougwilson/) + [![NPM Version][npm-image]][npm-url] + [![NPM Downloads][downloads-image]][downloads-url] + [![Build Status][travis-image]][travis-url] + [![Test Coverage][coveralls-image]][coveralls-url] ```js var express = require('express') @@ -18,14 +18,34 @@ app.get('/', function (req, res) { app.listen(3000) ``` - **PROTIP** Be sure to read [Migrating from 3.x to 4.x](https://github.com/strongloop/express/wiki/Migrating-from-3.x-to-4.x) as well as [New features in 4.x](https://github.com/strongloop/express/wiki/New-features-in-4.x). - ### Installation ```bash $ npm install express ``` +## Features + + * Robust routing + * Focus on high performance + * Super-high test coverage + * HTTP helpers (redirection, caching, etc) + * View system supporting 14+ template engines + * Content negotiation + * Executable for generating applications quickly + +## Docs & Community + + * [Website and Documentation](http://expressjs.com/) - [[website repo](https://github.com/strongloop/expressjs.com)] + * [#express](https://webchat.freenode.net/?channels=express) on freenode IRC + * [Github Organization](https://github.com/expressjs) for Official Middleware & Modules + * Visit the [Wiki](https://github.com/strongloop/express/wiki) + * [Google Group](https://groups.google.com/group/express-js) for discussion + * [Русскоязычная документация](http://jsman.ru/express/) + * [한국어 문서](http://expressjs.kr) - [[website repo](https://github.com/Hanul/expressjs.kr)] + +**PROTIP** Be sure to read [Migrating from 3.x to 4.x](https://github.com/strongloop/express/wiki/Migrating-from-3.x-to-4.x) as well as [New features in 4.x](https://github.com/strongloop/express/wiki/New-features-in-4.x). + ## Quick Start The quickest way to get started with express is to utilize the executable [`express(1)`](https://github.com/expressjs/generator) to generate an application as shown below: @@ -54,16 +74,6 @@ $ npm install $ npm start ``` -## Features - - * Robust routing - * HTTP helpers (redirection, caching, etc) - * View system supporting 14+ template engines - * Content negotiation - * Focus on high performance - * Executable for generating applications quickly - * High test coverage - ## Philosophy The Express philosophy is to provide small, robust tooling for HTTP servers, making @@ -74,20 +84,9 @@ $ npm start 14 template engines via [Consolidate.js](https://github.com/visionmedia/consolidate.js), you can quickly craft your perfect framework. -## More Information +## Examples - * [Website and Documentation](http://expressjs.com/) - [[website repo](https://github.com/strongloop/expressjs.com)] - * [Github Organization](https://github.com/expressjs) for Official Middleware & Modules - * [#express](https://webchat.freenode.net/?channels=express) on freenode IRC - * Visit the [Wiki](https://github.com/strongloop/express/wiki) - * [Google Group](https://groups.google.com/group/express-js) for discussion - * [Русскоязычная документация](http://jsman.ru/express/) - * [한국어 문서](http://expressjs.kr) - [[website repo](https://github.com/Hanul/expressjs.kr)] - * Run express examples [online](https://runnable.com/express) - -## Viewing Examples - - Clone the Express repo, then install the dev dependencies to install all the example / test suite dependencies: + To view the examples, clone the Express repo & install the dependancies: ```bash $ git clone git://github.com/strongloop/express.git --depth 1 @@ -97,32 +96,40 @@ $ npm install Then run whichever example you want: - $ node examples/content-negotiation +```bash +$ node examples/content-negotiation +``` - You can also view live examples here: +## Tests - - -## Running Tests - - To run the test suite, first invoke the following command within the repo, installing the development dependencies: + To run the test suite, first install the dependancies, then run `npm test`: ```bash $ npm install -``` - - Then run the tests: - -```bash $ npm test ``` -### Contributors +### People - * Author: [TJ Holowaychuk](https://github.com/visionmedia) - * Lead Maintainer: [Douglas Christopher Wilson](https://github.com/dougwilson) - * [All Contributors](https://github.com/strongloop/express/graphs/contributors) +The original author of Express is [TJ Holowaychuk](https://github.com/visionmedia) [![TJ's Gratipay][gratipay-image-visionmedia]][gratipay-url-visionmedia] + +The current lead maintainer is [Douglas Christopher Wilson](https://github.com/dougwilson) [![Doug's Gratipay][gratipay-image-dougwilson]][gratipay-url-dougwilson] + +[List of all contributors](https://github.com/strongloop/express/graphs/contributors) ### License [MIT](LICENSE) + +[npm-image]: https://img.shields.io/npm/v/express.svg?style=flat +[npm-url]: https://npmjs.org/package/express +[downloads-image]: https://img.shields.io/npm/dm/express.svg?style=flat +[downloads-url]: https://npmjs.org/package/express +[travis-image]: https://img.shields.io/travis/strongloop/express.svg?style=flat +[travis-url]: https://travis-ci.org/strongloop/express +[coveralls-image]: https://img.shields.io/coveralls/strongloop/express.svg?style=flat +[coveralls-url]: https://coveralls.io/r/strongloop/express?branch=master +[gratipay-image-visionmedia]: https://img.shields.io/gratipay/visionmedia.svg?style=flat +[gratipay-url-visionmedia]: https://gratipay/visionmedia/ +[gratipay-image-dougwilson]: https://img.shields.io/gratipay/dougwilson.svg?style=flat +[gratipay-url-dougwilson]: https://gratipay/dougwilson/