Skip to content

Commit

Permalink
docs: fix & update badges (#99)
Browse files Browse the repository at this point in the history
- update/fix "build status" badge according to Shields directions

- remove old `nodei.co` badge
  - doesn't always load and isn't very useful anymore
  - removing it from all of my NPM projects

- also change Installation to a codeblock instead of just backticks
  - easier to read as a block and easier to copy (full horizontal length)
  - and more consistent too

(cherry picked from commit cb09cf7)
- removed typings badge (v1.0.x isn't in TS)
- changed badge branches to point to `v1.0.x`
  • Loading branch information
agilgur5 committed Jan 3, 2025
1 parent 1bdd116 commit 21f5e6f
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 @@ -15,11 +15,9 @@
[![dm](https://img.shields.io/npm/dm/react-signature-canvas.svg)](https://npmjs.org/package/react-signature-canvas)
[![dw](https://img.shields.io/npm/dw/react-signature-canvas.svg)](https://npmjs.org/package/react-signature-canvas)
<br><!-- status / activity -->
[![build status](https://img.shields.io/github/workflow/status/agilgur5/react-signature-canvas/CI/main)](https://github.com/agilgur5/react-signature-canvas/actions/workflows/ci.yml?query=branch%3Amain)
[![code coverage](https://img.shields.io/codecov/c/gh/agilgur5/react-signature-canvas/main.svg)](https://codecov.io/gh/agilgur5/react-signature-canvas)
<br>
[![NPM](https://nodei.co/npm/react-signature-canvas.png?downloads=true&downloadRank=true&stars=true)](https://npmjs.org/package/react-signature-canvas)
<br>
[![build status](https://img.shields.io/github/actions/workflow/status/agilgur5/react-signature-canvas/ci.yml?branch=v1.0.x)](https://github.com/agilgur5/react-signature-canvas/actions/workflows/ci.yml?query=branch%3Av1.0.x)
[![code coverage](https://img.shields.io/codecov/c/gh/agilgur5/react-signature-canvas/v1.0.x.svg)](https://codecov.io/gh/agilgur5/react-signature-canvas)

A React wrapper component around [signature_pad](https://github.com/szimek/signature_pad).

Originally, this was just an _unopinionated_ fork of [react-signature-pad](https://github.com/blackjk3/react-signature-pad) that did not impose any styling or wrap any other unwanted elements around your canvas -- it's just a wrapper around a single canvas element!
Expand All @@ -30,7 +28,9 @@ This fork also allows you to directly pass [props](#props) to the underlying can

## Installation

`npm i -S react-signature-canvas`
```sh
npm i -S react-signature-canvas
```

## Usage

Expand Down

0 comments on commit 21f5e6f

Please sign in to comment.