next.js/examples/using-router/README.md

# Example app utilizing next/router for routing

## How to use

Download the example [or clone the repo](https://github.com/zeit/next.js):

```bash
curl https://codeload.github.com/zeit/next.js/tar.gz/master | tar -xz --strip=2 next.js-master/examples/using-router
cd using-router
```

Install it and run:

```bash
npm install
npm run dev
```

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

```bash
now
```

## The idea behind the example

This example features:

* An app linking pages using `next/router` instead of `<Link>` component.
* Access the pathname using `next/router` and render it in a component
Implement the Singleton Router API (#429) * Immplement the initial singleton Router. * Use the new SingletonRouter for HMR error handling. * Use SingletonRouter inside the Link. * Create an example app using the Router. * Make the url parameter optional in Router.push and Router.replace * Add a section about next/router in the README. 2016-12-19 14:40:26 +00:00			`# Example app utilizing next/router for routing`

Add/move examples (#470) * Added redux and styled components (wip) examples. * Updated examples readmes and package.json * Fixed styled-components example 2016-12-22 05:10:54 +00:00			`## How to use`
Implement the Singleton Router API (#429) * Immplement the initial singleton Router. * Use the new SingletonRouter for HMR error handling. * Use SingletonRouter inside the Link. * Create an example app using the Router. * Make the url parameter optional in Router.push and Router.replace * Add a section about next/router in the README. 2016-12-19 14:40:26 +00:00
Fix link (#789) * Fix link * Fix links 2017-01-16 21:23:24 +00:00			`Download the example [or clone the repo](https://github.com/zeit/next.js):`
Add/move examples (#470) * Added redux and styled components (wip) examples. * Updated examples readmes and package.json * Fixed styled-components example 2016-12-22 05:10:54 +00:00
			```bash
examples: simplify download instruction 2016-12-22 09:07:54 +00:00			`curl https://codeload.github.com/zeit/next.js/tar.gz/master \| tar -xz --strip=2 next.js-master/examples/using-router`
			`cd using-router`
Add/move examples (#470) * Added redux and styled components (wip) examples. * Updated examples readmes and package.json * Fixed styled-components example 2016-12-22 05:10:54 +00:00			```
Implement the Singleton Router API (#429) * Immplement the initial singleton Router. * Use the new SingletonRouter for HMR error handling. * Use SingletonRouter inside the Link. * Create an example app using the Router. * Make the url parameter optional in Router.push and Router.replace * Add a section about next/router in the README. 2016-12-19 14:40:26 +00:00
Add/data fetch example (#485) * Added data fetch example * Finished updating examples install instructions and added data-fetch example to main readme 2016-12-22 23:05:49 +00:00			`Install it and run:`
Add/move examples (#470) * Added redux and styled components (wip) examples. * Updated examples readmes and package.json * Fixed styled-components example 2016-12-22 05:10:54 +00:00
			```bash
Implement the Singleton Router API (#429) * Immplement the initial singleton Router. * Use the new SingletonRouter for HMR error handling. * Use SingletonRouter inside the Link. * Create an example app using the Router. * Make the url parameter optional in Router.push and Router.replace * Add a section about next/router in the README. 2016-12-19 14:40:26 +00:00			`npm install`
Add/data fetch example (#485) * Added data fetch example * Finished updating examples install instructions and added data-fetch example to main readme 2016-12-22 23:05:49 +00:00			`npm run dev`
Add/move examples (#470) * Added redux and styled components (wip) examples. * Updated examples readmes and package.json * Fixed styled-components example 2016-12-22 05:10:54 +00:00			```

Add/data fetch example (#485) * Added data fetch example * Finished updating examples install instructions and added data-fetch example to main readme 2016-12-22 23:05:49 +00:00			`Deploy it to the cloud with [now](https://zeit.co/now) ([download](https://zeit.co/download))`
Add/move examples (#470) * Added redux and styled components (wip) examples. * Updated examples readmes and package.json * Fixed styled-components example 2016-12-22 05:10:54 +00:00
			```bash
Add/data fetch example (#485) * Added data fetch example * Finished updating examples install instructions and added data-fetch example to main readme 2016-12-22 23:05:49 +00:00			`now`
Implement the Singleton Router API (#429) * Immplement the initial singleton Router. * Use the new SingletonRouter for HMR error handling. * Use SingletonRouter inside the Link. * Create an example app using the Router. * Make the url parameter optional in Router.push and Router.replace * Add a section about next/router in the README. 2016-12-19 14:40:26 +00:00			```
Add/move examples (#470) * Added redux and styled components (wip) examples. * Updated examples readmes and package.json * Fixed styled-components example 2016-12-22 05:10:54 +00:00
			`## The idea behind the example`

			`This example features:`

			* An app linking pages using `next/router` instead of `<Link>` component.
			* Access the pathname using `next/router` and render it in a component