Skip to content

Commit

Permalink
docs: use buefy alias in install instruction (#225)
Browse files Browse the repository at this point in the history
The installation instruction in `README.md` shows how to install
`@ntohq/buefy-next` under the `buefy` alias.
  • Loading branch information
kikuomax authored Apr 4, 2024
1 parent c320fed commit 5e1c167
Showing 1 changed file with 5 additions and 2 deletions.
7 changes: 5 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,9 +40,12 @@ The biggest breaking change is obviously, **this does not work with Vue 2**.
To install this fork, please run the following command,

```sh
npm install @ntohq/buefy-next
npm install buefy@npm:@ntohq/buefy-next
```

The above command will install `@ntohq/buefy-next` under the `buefy` alias.
This is recommended because `@ntohq/buefy-next` will replace `buefy` when it becomes stable.

## Features

* Keep your current Bulma theme / variables easily
Expand All @@ -66,7 +69,7 @@ You need [Vue.js](https://vuejs.org/) **version 3.0+**. (Vue 2 is not supported)
### 1 Install via npm

```bash
npm install https://github.com/buefy/buefy#buefy-next
npm install buefy@npm:@ntohq/buefy-next
```

### 2 Import and use Buefy
Expand Down

0 comments on commit 5e1c167

Please sign in to comment.