From 3c6c84b61b29dda2fe5ca8f396d599523a1caf82 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?D=C3=A1rio=20Silva?= Date: Mon, 2 Feb 2026 10:45:14 +0100 Subject: [PATCH 1/2] docs: improves usage instructions format --- README.md | 19 ++++++++++++++++++- 1 file changed, 18 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index ed89641..1e80032 100644 --- a/README.md +++ b/README.md @@ -9,7 +9,24 @@ React Gauge Chart Component for data visualization. A gallery of preset gauges and a sandbox editor is provided so you can create and edit your gauges in the [DEMO](https://antoniolago.github.io/react-gauge-component) page # Usage -Install it by running `npm install react-gauge-component --save` or `yarn add react-gauge-component`. Then to use it: + +## Installing with `npm`: + +```js +npm install react-gauge-component --save +``` +## Installing with `pnpm`: + +```js +pnpm add react-gauge-component --save +``` + +## Installing with `yarn`: +``` +yarn add react-gauge-component. +``` + +### Then use it: ```jsx import GaugeComponent from 'react-gauge-component'; From 9fa6a468b1c30af8a61ddd91eb71bffb52a792fe Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ant=C3=B4nio=20Lago?= <45375617+antoniolago@users.noreply.github.com> Date: Mon, 2 Feb 2026 14:51:31 -0300 Subject: [PATCH 2/2] Update README.md --- README.md | 13 ++++++------- 1 file changed, 6 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 1e80032..788231c 100644 --- a/README.md +++ b/README.md @@ -8,25 +8,24 @@ React Gauge Chart Component for data visualization. A gallery of preset gauges and a sandbox editor is provided so you can create and edit your gauges in the [DEMO](https://antoniolago.github.io/react-gauge-component) page -# Usage +## Quick Start -## Installing with `npm`: +Install with your package manager ```js npm install react-gauge-component --save ``` -## Installing with `pnpm`: - ```js pnpm add react-gauge-component --save ``` - -## Installing with `yarn`: ``` yarn add react-gauge-component. ``` +``` +bun add react-gauge-component. +``` -### Then use it: +Then import it: ```jsx import GaugeComponent from 'react-gauge-component';