Skip to content

Commit

Permalink
Remove duplicated README
Browse files Browse the repository at this point in the history
  • Loading branch information
almothafar committed Sep 16, 2024
1 parent c89de9a commit cdae95a
Show file tree
Hide file tree
Showing 4 changed files with 18 additions and 80 deletions.
16 changes: 14 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,18 @@
# Angular Signature Pad

[![npm downloads](https://img.shields.io/npm/dt/@almothafar/angular-signature-pad.svg)](https://www.npmjs.com/package/@almothafar/angular-signature-pad)
[![npm version](https://img.shields.io/npm/v/@almothafar/angular-signature-pad.svg)](https://www.npmjs.com/package/@almothafar/angular-signature-pad)
[![npm license](https://img.shields.io/npm/l/@almothafar/angular-signature-pad.svg)](https://www.npmjs.com/package/@almothafar/angular-signature-pad)
[![GitHub issues](https://img.shields.io/github/issues/almothafar/angular-signature-pad.svg)](https://github.com/almothafar/angular-signature-pad/issues)


Angular component for [szimek/signature_pad](https://www.npmjs.com/package/signature_pad).

## Install
`npm install @almothafar/angular-signature-pad --save`

```shell
npm install @almothafar/angular-signature-pad --save
```

## Reference Implementation

Expand All @@ -14,9 +24,11 @@ Angular component for [szimek/signature_pad](https://www.npmjs.com/package/signa
API is identical to [szimek/signature_pad](https://www.npmjs.com/package/signature_pad).

Options are as per [szimek/signature_pad](https://www.npmjs.com/package/signature_pad) with the following additions:

* canvasWidth: width of the canvas (px)
* canvasHeight: height of the canvas (px)
The above options are provided to avoid accessing the DOM directly from your component to adjust the canvas size.

The above options are provided to avoid accessing the DOM directly from your component to adjust the canvas size.

```typescript

Expand Down
5 changes: 3 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -5,12 +5,13 @@
"ng": "ng",
"start": "ng serve",
"build": "ng build",
"build:prod": "rimraf dist && ng build angular-signature-pad --configuration production",
"build:prod": "rimraf dist && ng build angular-signature-pad --configuration production && npm run copyREADME",
"pack": "cd dist/ && npm pack",
"publish": "cd dist/ && npm publish --access=public",
"test": "ng test",
"lint": "ng lint",
"e2e": "ng e2e"
"e2e": "ng e2e",
"copyREADME": "node -e \"require('fs').cpSync('README.md', './dist/README.md');\""
},
"dependencies": {
"@angular/animations": "^18.2.4",
Expand Down
75 changes: 0 additions & 75 deletions projects/angular-signature-pad/README.md

This file was deleted.

2 changes: 1 addition & 1 deletion projects/angular-signature-pad/ng-package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"$schema": "../../node_modules/ng-packagr/ng-package.schema.json",
"dest": "../../dist/angular-signature-pad",
"dest": "../../dist/",
"lib": {
"entryFile": "src/public-api.ts"
},
Expand Down

0 comments on commit cdae95a

Please sign in to comment.