Skip to content

Commit

Permalink
Add more instructions to README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
venables committed Mar 24, 2023
1 parent db5e855 commit e1e9ba6
Showing 1 changed file with 40 additions and 12 deletions.
52 changes: 40 additions & 12 deletions README.md
Expand Up @@ -4,6 +4,46 @@

> A sane starting point for Next.js projects.
## Features

- [Next.js 13.2](https://nextjs.org) with the `/app` directory
- [Typescript](https://www.typescriptlang.org/) for a rock-solid codebase
- [ESLint](https://eslint.org/) + [Prettier](https://prettier.io/) for readable, safe code.
- [TailwindCSS](https://tailwindcss.com/) for utility-first CSS.
- The beautiful [Inter](https://rsms.me/inter/) typeface.
- [Next Metadata API](https://beta.nextjs.org/docs/api-reference/metadata) for SEO handling.
- [Jest](https://jestjs.io/) testing, optimized for Next.js
- Automatic Dark Mode support (based on system setting).
- Sane VSCode settings and recommended extensions

## Starting a new project with StartKit

1. Clone this repo to your desired path:

```sh
git clone git@github.com:startkit-dev/startkit-next.git my-new-project
```

2. Rename the project:

```sh
./bin/rename
```

3. Update your git remote to point to StartKit as `upstream`

```sh
git remote rename origin upstream
```

In the future, you'll be able to pull in the latest StartKit changes without
missing a beat by running:

```sh
git fetch upstream
git pull upstream/main
```

## Getting Started

```sh
Expand All @@ -18,18 +58,6 @@ pnpm run dev

The app will be running at [http://localhost:3000](http://localhost:3000).

## Features

- [Next.js](https://nextjs.org)
- [Typescript](https://www.typescriptlang.org/) for a rock-solid codebase
- [ESLint](https://eslint.org/) + [Prettier](https://prettier.io/) for readable, safe code.
- [TailwindCSS](https://tailwindcss.com/) for utility-first CSS.
- The beautiful [Inter](https://rsms.me/inter/) typeface.
- [Next Metadata API](https://beta.nextjs.org/docs/api-reference/metadata) for SEO handling.
- [Jest](https://jestjs.io/) testing, optimized for Next.js
- Automatic Dark Mode support (based on system setting).
- Sane VSCode settings and recommended extensions

## Naming the project

The StartKit name is used throughout the project, you should find and replace
Expand Down

1 comment on commit e1e9ba6

@vercel
Copy link

@vercel vercel bot commented on e1e9ba6 Mar 24, 2023

Choose a reason for hiding this comment

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

Please sign in to comment.