Skip to content

Commit

Permalink
Merge pull request #35 from eruptionjs/docs/update-readme
Browse files Browse the repository at this point in the history
docs: update the main readme to use the create-eruption CLI
  • Loading branch information
raisiqueira authored Apr 28, 2023
2 parents de4aa54 + ad26065 commit b1829b5
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,12 +20,12 @@ _It's fast! Even the tests are fast, thanks to Vite with Vitest ⚡️_

# Installation

This project uses [DEGIT](https://github.com/Rich-Harris/degit) to scaffold. A friendly CLI is coming soon to improve the DX 👀.
There are two ways to install Eruption: using the template directly from GitHub (through the "Use Template" button), or using the [CLI](https://www.npmjs.com/package/create-eruption).

first, clone the project and give it a name
If you want to use the CLI, run the following command on your terminal:

```Bash
npx degit github:eruptionjs/core#main your-project-name
npm init eruption@latest
```

then, to start the project
Expand Down

0 comments on commit b1829b5

Please sign in to comment.