Skip to content

Commit

Permalink
docs: update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
tclxshunquan-wang committed Aug 25, 2024
1 parent cd076b2 commit 5fd49ce
Showing 1 changed file with 6 additions and 6 deletions.
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,8 +36,8 @@

Before you begin, make sure you have the following installed:

* Node.js (recommended version 16.x or higher)
* npm (comes with Node.js)
- Node.js (recommended version 16.x or higher)
- npm (comes with Node.js)

## Installation

Expand All @@ -52,7 +52,7 @@ yarn add @hyperse/track
## Development

> \[!IMPORTANT]
> The following instructions are for those who want to develop the hyperse related framework or plugins (e.g. if you intend to make a pull request). For instructions on how to build a project *using* Hyperse, please see the [Getting Started guide](https://hyperse-io.github.io/track/docs/community/contributing).
> The following instructions are for those who want to develop the hyperse related framework or plugins (e.g. if you intend to make a pull request). For instructions on how to build a project _using_ Hyperse, please see the [Getting Started guide](https://hyperse-io.github.io/track/docs/community/contributing).
### 1. Clone project to the local directory

Expand All @@ -74,9 +74,9 @@ npm install

The root directory has a `package.json` which contains build-related dependencies for tasks including:

* Building & deploying the docs
* Project for online presentation
* Linting, formatting & testing tasks to run on git commit & push
- Building & deploying the docs
- Project for online presentation
- Linting, formatting & testing tasks to run on git commit & push

### 3. Testing

Expand Down

0 comments on commit 5fd49ce

Please sign in to comment.