To contribute to [our examples](examples), take a look at the [“Adding examples” section](#adding-examples).

When you add an example to the [examples](examples) directory, don’t forget to add a `README.md` file with the following format:

- Replace `DIRECTORY_NAME` with the directory name you’re adding.

- Fill in `Example Name` and `Description`.

- To add additional installation instructions, please add it where appropriate.

- To add additional notes, add `## Notes` section at the end.

- Remove the `Deploy your own` section if your example can’t be immediately deployed to ZEIT Now.

# Example Name

Description

## Deploy your own

Deploy the example using [ZEIT Now](https://zeit.co/now):

[](https://zeit.co/new/project?template=https://github.com/zeit/next.js/tree/canary/examples/DIRECTORY_NAME)

## How to use

### Using `create-next-app`

Execute [`create-next-app`](https://github.com/zeit/next.js/tree/canary/packages/create-next-app) with [npm](https://docs.npmjs.com/cli/init) or [Yarn](https://yarnpkg.com/lang/en/docs/cli/create/) to bootstrap the example:

```bash

npx create-next-app --example DIRECTORY_NAME DIRECTORY_NAME-app

# or

yarn create next-app --example DIRECTORY_NAME DIRECTORY_NAME-app

```

### Download manually

Download the example:

```bash

curl https://codeload.github.com/zeit/next.js/tar.gz/canary | tar -xz --strip=2 next.js-canary/examples/DIRECTORY_NAME

cd DIRECTORY_NAME

```

Install it and run:

```bash

npm install

npm run dev

# or

yarn

yarn dev

```

Deploy it to the cloud with [now](https://zeit.co/now) ([download](https://zeit.co/download)):

```bash

now

```