From ee0e9d430cfc7927f6e21507f6dcd52f07f8dca2 Mon Sep 17 00:00:00 2001 From: Astrian Zheng Date: Thu, 20 Feb 2025 11:42:18 +1100 Subject: [PATCH] docs: add contribution and development instructions to README --- README.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/README.md b/README.md index aa8b936..6419ef9 100644 --- a/README.md +++ b/README.md @@ -64,6 +64,15 @@ export default () => { More features are on the roadmap. +## Contribution & Development + +```zsh +npm i # or `yarn` +npm run dev # or `yarn dev` +``` + +Then the package will launch a testing React hot-reload server in `localhost:1926`. The server file available in `playground` folder, feel free to modify content inside it. + ## License MIT \ No newline at end of file