Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

More helpful README #14830

Merged
merged 9 commits into from
Jul 24, 2020
Merged

More helpful README #14830

Changes from 1 commit
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
a784011
More helpful README
MehediH Jul 3, 2020
f1b1b17
create-next-app readme
MehediH Jul 5, 2020
07a3add
Apply edits from code review
MehediH Jul 22, 2020
47e09f6
Remove redundant intro
MehediH Jul 22, 2020
8468e0f
Update packages/create-next-app/README.md
lfades Jul 23, 2020
cd7d7b8
Remove introduction and list in showcase
MehediH Jul 23, 2020
af65835
Apply suggestions from code review
lfades Jul 24, 2020
1ba35be
Update packages/next/README.md
lfades Jul 24, 2020
8b95780
Merge branch 'canary' into canary
kodiakhq[bot] Jul 24, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
39 changes: 36 additions & 3 deletions packages/next/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,13 +15,46 @@
</a>
</p>

## The React Framework

Next.js is used by the world's leading companies and independent developers.

* **Pre-Rendering** - Statically generated and server-rendered React applications have never been easier.
* **Static Exporting** - No need to learn a new framework. Exporting a static site with Next.js is as easy as a single command.
* **CSS-in-JS** - Next.js comes with `styled-jsx` included, but it also works with every CSS-in-JS solution you know and love.
* **Built-in TypeScript support** - Next.js provides an integrated TypeScript experience out of the box, similar to an IDE.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* **Built-in TypeScript support** - Next.js provides an integrated TypeScript experience out of the box, similar to an IDE.
* **Built-in TypeScript Support** - Next.js provides an integrated TypeScript experience out of the box, similar to an IDE.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi @Timer, @lfades suggested that this was redundant and the readme should directly link to https://nextjs.org/learn instead. Please let me know what you think, and if I should keep this on the Next.js readme.

* **Zero Configuration** - Automatic code splitting, filesystem based routing, hot code reloading and universal rendering. All included.
* **Fully Extensible** - Complete control over Babel and Webpack. Customizable server, routing and next-plugins.
* **Ready for Production** - Optimized for a smaller build size, faster dev compilation and dozens of other improvements.

lfades marked this conversation as resolved.
Show resolved Hide resolved
## Getting Started

Visit <a aria-label="next.js learn" href="https://nextjs.org/learn">https://nextjs.org/learn</a> to get started with Next.js.
Creating a new app with Next.js is easy with the `create-next-app` CLI. Create Next App allows you to create a Next.js app with a single command and set up everything for you, enabling you to get started within minutes.

```sh
npx create-next-app
# or
yarn create next-app
```

For more details on getting started with Next.js, including how to manually create a new app, <a aria-label="Next.js getting started instructions" href="https://nextjs.org/docs/getting-started#setup">follow the instructions here.</a>
MehediH marked this conversation as resolved.
Show resolved Hide resolved

## Learning and Documentation

Learning the basics of Next.js is easy with our <a aria-label="next.js learn" href="https://nextjs.org/learn/basics/create-nextjs-app">step-by-step guide available here.</a> The interactive tutorial guides you through some of the fundamental concepts of Next.js. You can earn points as you go, and make a <a aria-label="Next.js Learn demo blog" href="https://next-learn-starter.now.sh/">very simple blog app</a> within a few hours.

Visit <a aria-label="next.js learn" href="https://nextjs.org/docs">https://nextjs.org/docs</a> to view the full documentation.
MehediH marked this conversation as resolved.
Show resolved Hide resolved
lfades marked this conversation as resolved.
Show resolved Hide resolved

## Who is using Next.js?

Next.js is used by the world's leading companies. You can check out the <a aria-label="Next.js Showcase" href="https://nextjs.org/showcase">full showcase here</a>, but here are just a few we love:

## Documentation
* <a aria-label="Twitch site built with Next.js" href="https://nextjs.org/showcase/twitch">Twitch</a>
* <a aria-label="Hulu site built with Next.js" href="https://nextjs.org/showcase/hulu">Hulu</a>
* <a aria-label="TikTok site built with Next.js" href="https://nextjs.org/showcase/tiktok">TikTok</a>
* <a aria-label="Nike site built with Next.js" href="https://nextjs.org/showcase/nike">Nike</a>
* <a aria-label="Marvel site built with Next.js" href="https://nextjs.org/showcase/marvel">Marvel</a>
MehediH marked this conversation as resolved.
Show resolved Hide resolved

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

## Contributing

Expand Down