Skip to content

Commit

Permalink
More helpful README (#14830)
Browse files Browse the repository at this point in the history
* More helpful README

Updated to include more details about Next.js, link to the interactive tutorial, showcase, etc. Content mostly based on the official Next.js site.

* create-next-app readme

An updated readme with more details on options, benefits, etc.

* Apply edits from code review

Co-authored-by: Luis Alvarez D. <luis@vercel.com>

* Remove redundant intro

* Update packages/create-next-app/README.md

* Remove introduction and list in showcase

* Apply suggestions from code review

* Update packages/next/README.md

Co-authored-by: Luis Alvarez D. <luis@vercel.com>
Co-authored-by: kodiakhq[bot] <49736102+kodiakhq[bot]@users.noreply.github.com>
  • Loading branch information
3 people committed Jul 24, 2020
1 parent 23ebe3e commit 00ebce5
Show file tree
Hide file tree
Showing 2 changed files with 32 additions and 6 deletions.
32 changes: 27 additions & 5 deletions packages/create-next-app/README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,30 @@
# create-next-app
# Create Next App

This package includes the global command for creating [Next.js](https://github.com/vercel/next.js) applications.
The easiest way to get started with Next.js is by using `create-next-app`. This simple CLI tool enables you to quickly start building a new Next.js application, with everything set up for you. You can create a new app using the default Next.js template, or by using one of the [official Next.js examples](https://github.com/vercel/next.js/tree/canary/examples). To get started, use the following command:

Please refer to its documentation:
```bash
npx create-next-app
```

- [Setup](https://nextjs.org/docs/getting-started#setup) – How to create a new Next.js application.
- [Documentation](https://nextjs.org/docs) – How to develop Next.js applications.
To create a new app in a specific folder, you can send a name as an argument. For example, the following command will create a new Next.js app called `blog-app` in a folder with the same name:

```bash
npx create-next-app blog-app
```

## Options

`create-next-app` comes with the following options:

* **-e, --example [name]|[github-url]** - An example to bootstrap the app with. You can use an example name from the [Next.js repo](https://github.com/vercel/next.js/tree/master/examples) or a GitHub URL. The URL can use any branch and/or subdirectory.
* **--example-path &lt;path-to-example&gt;** - In a rare case, your GitHub URL might contain a branch name with a slash (e.g. bug/fix-1) and the path to the example (e.g. foo/bar). In this case, you must specify the path to the example separately: `--example-path foo/bar`

## Why use Create Next App?

`create-next-app` allows you to create a new Next.js app within seconds. It is officially maintained by the creators of Next.js, and includes a number of benefits:

* **Interactive Experience**: Running `npx create-next-app` (with no arguments) launches an interactive experience that guides you through setting up a project.
* **Zero Dependencies**: Initializing a project is as quick as one second. Create Next App has zero dependencies.
* **Offline Support**: Create Next App will automatically detect if you're offline and bootstrap your project using your local package cache.
* **Support for Examples**: Create Next App can bootstrap your application using an example from the Next.js examples collection (e.g. `npx create-next-app --example api-routes`).
* **Tested**: The package is part of the Next.js monorepo and tested using the same integration test suite as Next.js itself, ensuring it works as expected with every release.
6 changes: 5 additions & 1 deletion packages/next/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,11 @@ Visit <a aria-label="next.js learn" href="https://nextjs.org/learn">https://next

## Documentation

Visit <a aria-label="next.js learn" href="https://nextjs.org/docs">https://nextjs.org/docs</a> to view the documentation.
Visit [https://nextjs.org/docs](https://nextjs.org/docs) to view the full documentation.

## Who is using Next.js?

Next.js is used by the world's leading companies. Check out the [Next.js Showcase](https://nextjs.org/showcase) to learn more.

## Contributing

Expand Down

0 comments on commit 00ebce5

Please sign in to comment.