Skip to content

Commit

Permalink
docs(root): update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
hendraaagil authored Jun 2, 2021
1 parent 89e0daf commit 8a9336a
Showing 1 changed file with 6 additions and 5 deletions.
11 changes: 6 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

## Getting Started

1. Clone this project <br />
1. Clone this template, change "next-chakra-project" with your own project name <br />

```bash
git clone https://github.com/hendraaagil/next-chakra-starter "next-chakra-project"
Expand All @@ -15,14 +15,14 @@
Recommended using yarn

```bash
cd next-chakra-starter
cd next-chakra-project
yarn
```

or using npm

```bash
cd next-chakra-starter
cd next-chakra-project
npm install
```

Expand All @@ -48,8 +48,9 @@ Some features in this template:
3. Page transition <br />
If you want to custom the page transition go to `pages/_app.js` in `MotionBox` component.
4. Next SEO config file <br />
You can custom `meta`, favicon, open graph, etc. in `next-seo.config.js`
5. You also can customize nprogress in `styles/css/nprogress.css`
You can custom `meta`, favicon, open graph, etc. in `next-seo.config.js`.
5. You also can customize nprogress in `styles/css/nprogress.css`.
6. Using absolute path based on `jsconfig.json` file.

## Documentation

Expand Down

1 comment on commit 8a9336a

@vercel
Copy link

@vercel vercel bot commented on 8a9336a Jun 2, 2021

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.