Skip to content

Commit

Permalink
docs: consolidate contributing in readme
Browse files Browse the repository at this point in the history
  • Loading branch information
dougwilson committed Mar 1, 2022
1 parent 4ed35b4 commit 07aa91f
Showing 1 changed file with 26 additions and 21 deletions.
47 changes: 26 additions & 21 deletions Readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,6 @@

[![NPM Version][npm-version-image]][npm-url]
[![NPM Downloads][npm-downloads-image]][npm-downloads-url]
[![Linux Build][github-actions-ci-image]][github-actions-ci-url]
[![Windows Build][appveyor-image]][appveyor-url]
[![Test Coverage][coveralls-image]][coveralls-url]

```js
const express = require('express')
Expand All @@ -33,7 +30,7 @@ the [`npm init` command](https://docs.npmjs.com/creating-a-package-json-file).
Installation is done using the
[`npm install` command](https://docs.npmjs.com/getting-started/installing-npm-packages-locally):

```bash
```console
$ npm install express
```

Expand Down Expand Up @@ -61,35 +58,31 @@ for more information.

**PROTIP** Be sure to read [Migrating from 3.x to 4.x](https://github.com/expressjs/express/wiki/Migrating-from-3.x-to-4.x) as well as [New features in 4.x](https://github.com/expressjs/express/wiki/New-features-in-4.x).

### Security Issues

If you discover a security vulnerability in Express, please see [Security Policies and Procedures](Security.md).

## 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:

Install the executable. The executable's major version will match Express's:

```bash
```console
$ npm install -g express-generator@4
```

Create the app:

```bash
```console
$ express /tmp/foo && cd /tmp/foo
```

Install dependencies:

```bash
```console
$ npm install
```

Start the server:

```bash
```console
$ npm start
```

Expand All @@ -109,31 +102,43 @@ $ npm start

To view the examples, clone the Express repo and install the dependencies:

```bash
```console
$ git clone git://github.com/expressjs/express.git --depth 1
$ cd express
$ npm install
```

Then run whichever example you want:

```bash
```console
$ node examples/content-negotiation
```

## Tests
## Contributing

[![Linux Build][github-actions-ci-image]][github-actions-ci-url]
[![Windows Build][appveyor-image]][appveyor-url]
[![Test Coverage][coveralls-image]][coveralls-url]

The Express.js project welcomes all constructive contributions. Contributions take many forms,
from code for bug fixes and enhancements, to additions and fixes to documentation, additional
tests, triaging incoming pull requests and issues, and more!

See the [Contributing Guide](Contributing.md) for more technical details on contributing.

To run the test suite, first install the dependencies, then run `npm test`:
### Security Issues

If you discover a security vulnerability in Express, please see [Security Policies and Procedures](Security.md).

```bash
### Running Tests

To run the test suite, first install the dependencies, then run `npm test`:

```console
$ npm install
$ npm test
```

## Contributing

[Contributing Guide](Contributing.md)

## People

The original author of Express is [TJ Holowaychuk](https://github.com/tj)
Expand Down

0 comments on commit 07aa91f

Please sign in to comment.