Skip to content

Commit 932d26d

Browse files
author
Rafa AS
committed
refactor(packaging): rename NPM to @techiediaries/ngx-qrcode
rename the NPM package to add organization scope BREAKING CHANGE: rename this package, @techiediaries/ngx-qrcode must be used instead Closes #47
1 parent 6395648 commit 932d26d

File tree

10 files changed

+34
-32
lines changed

10 files changed

+34
-32
lines changed

README.md

Lines changed: 19 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,34 +1,38 @@
1-
# ngx-qrcode2
1+
# @techiediaries/ngx-qrcode
22

3-
`ngx-qrcode2` An Angular Component library for Generating QR (Quick Response ) Codes.
3+
```diff
4+
! ⚠️ WARNING: The NPM package ngx-qrcode2 has been deprecated. Use @techiediaries/ngx-qrcode instead.
5+
```
6+
7+
`@techiediaries/ngx-qrcode` An Angular Component library for Generating QR (Quick Response ) Codes.
48

5-
You can use the `ngx-qrcode2` to easily generate QR codes inside your Angular 6 or Ionic 3 applications
9+
You can use the `@techiediaries/ngx-qrcode` to easily generate QR codes inside your Angular 6 or Ionic 3 applications
610

711
>QR code (abbreviated from Quick Response Code) is the trademark for a type of matrix barcode (or two-dimensional barcode) first designed for the automotive industry in Japan. A barcode is a machine-readable optical label that contains information about the item to which it is attached. A QR code uses four standardized encoding modes (numeric, alphanumeric, byte/binary, and kanji) to efficiently store data; extensions may also be used. [Source](https://en.wikipedia.org/wiki/QR_code)
812
9-
## How to install ngx-qrcode2?
13+
## How to install @techiediaries/ngx-qrcode?
1014

1115
To use ngx-qrcode in your project, install it via npm or yarn:
1216

1317
```bash
14-
$ npm install ngx-qrcode2 --save
18+
$ npm install @techiediaries/ngx-qrcode --save
1519
or
16-
$ yarn add ngx-qrcode2
20+
$ yarn add @techiediaries/ngx-qrcode
1721
```
1822

19-
## How to use ngx-qrcode2?
23+
## How to use @techiediaries/ngx-qrcode?
2024

2125
For a complete and detailed tutorial on how to use this library. See:
2226

2327
[How to Generate QR Codes In Angular 4+ Applications ](https://www.techiediaries.com/generate-qrcodes-angular)
2428

2529

26-
Import `NgxQRCodeModule` from `ngx-qrcode2` into your `app.module.ts`:
30+
Import `NgxQRCodeModule` from `@techiediaries/ngx-qrcode` into your `app.module.ts`:
2731

2832
```ts
2933
import { BrowserModule } from '@angular/platform-browser';
3034
import { NgModule } from '@angular/core';
31-
import { NgxQRCodeModule } from 'ngx-qrcode2';
35+
import { NgxQRCodeModule } from '@techiediaries/ngx-qrcode';
3236

3337
import { AppComponent } from './app.component';
3438

@@ -55,15 +59,15 @@ In `app.component.html`, add:
5559

5660
<div style="text-align:center">
5761
<h1>
58-
ngx-qrcode2 demo
62+
@techiediaries/ngx-qrcode demo
5963
</h1>
6064
</div>
6165

6266
<ngx-qrcode
63-
[elementType]="elementType"
64-
[value] = "value"
65-
cssClass = "aclass"
66-
errorCorrectionLevel = "L">
67+
[elementType]="elementType"
68+
[value] = "value"
69+
cssClass = "aclass"
70+
errorCorrectionLevel = "L">
6771
</ngx-qrcode>
6872

6973
```
@@ -85,7 +89,7 @@ export class AppComponent {
8589
```
8690

8791

88-
## How to develop ngx-qrcode2?
92+
## How to develop @techiediaries/ngx-qrcode?
8993

9094
To generate all `*.js`, `*.d.ts` and `*.metadata.json` files:
9195

package.json

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
2-
"name": "ngx-qrcode2",
3-
"version": "9.0.0",
2+
"name": "@techiediaries/ngx-qrcode",
3+
"version": "9.0.1",
44
"scripts": {
55
"ng": "ng",
66
"start": "ng serve ngx-qrcode-demo",
@@ -15,7 +15,7 @@
1515
"lib:package": "yarn build && yarn copy:readme",
1616
"prelib:publish": "yarn lib:package",
1717
"lib:publish": "cd ./dist/ngx-qrcode && yarn publish --access=public",
18-
"tags": "yarn tag list ngx-qrcode2"
18+
"tags": "yarn tag list @techiediaries/ngx-qrcode"
1919
},
2020
"repository": {
2121
"type": "git",

projects/ngx-qrcode-demo/src/app/app.component.html

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,5 +7,4 @@
77
[errorCorrectionLevel]="correctionLevel"
88
[value]="value"
99
alt="Demo QR Code"
10-
cssClass="aclass">
11-
</ngx-qrcode>
10+
cssClass="aclass"></ngx-qrcode>

projects/ngx-qrcode-demo/src/app/app.component.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
import { Component } from '@angular/core';
2-
import { NgxQrcodeElementTypes, NgxQrcodeErrorCorrectionLevels } from 'ngx-qrcode2';
2+
import { NgxQrcodeElementTypes, NgxQrcodeErrorCorrectionLevels } from '@techiediaries/ngx-qrcode';
33

44
@Component({
55
selector: 'app-root',

projects/ngx-qrcode-demo/src/app/app.module.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
import { BrowserModule } from '@angular/platform-browser';
22
import { NgModule } from '@angular/core';
33

4-
import { NgxQRCodeModule } from 'ngx-qrcode2';
4+
import { NgxQRCodeModule } from '@techiediaries/ngx-qrcode';
55

66
import { AppComponent } from './app.component';
77

projects/ngx-qrcode-demo/tsconfig.app.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
"outDir": "../../out-tsc/app",
55
"types": [],
66
"paths": {
7-
"ngx-qrcode2": [
7+
"@techiediaries/ngx-qrcode": [
88
"projects/ngx-qrcode/src/public-api.ts"
99
]
1010
}

projects/ngx-qrcode-demo/tsconfig.spec.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
"node"
88
],
99
"paths": {
10-
"ngx-qrcode2": [
10+
"@techiediaries/ngx-qrcode": [
1111
"projects/ngx-qrcode/src/public-api.ts"
1212
]
1313
}

projects/ngx-qrcode/package.json

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,9 @@
11
{
2-
"name": "ngx-qrcode2",
3-
"version": "9.0.0",
4-
"description": "An Angular component for generating QRCodes ",
5-
"homepage": "https://www.techiediaries.com/ngx-qrcode",
2+
"name": "@techiediaries/ngx-qrcode",
3+
"version": "9.0.1",
4+
"description": "An Angular component for generating QRCodes",
5+
"homepage": "https://github.com/techiediaries/ngx-qrcode",
6+
"private": false,
67
"repository": {
78
"type": "git",
89
"url": "https://github.com/techiediaries/ngx-qrcode"

projects/ngx-qrcode/src/lib/qrcode.component.ts

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,7 @@ import { DEFAULT_VALUES } from './qrcode.constants';
77

88
@Component({
99
selector: 'ngx-qrcode',
10-
template: `
11-
<div #qrcElement [class]="cssClass"></div>`,
10+
template: `<div #qrcElement [class]="cssClass"></div>`,
1211
changeDetection: ChangeDetectionStrategy.OnPush
1312
})
1413
export class QrcodeComponent implements OnChanges {
@@ -18,7 +17,6 @@ export class QrcodeComponent implements OnChanges {
1817
@Input() alt: string;
1918
@Input() value = DEFAULT_VALUES.value;
2019
@Input() version = DEFAULT_VALUES.version;
21-
2220
@Input() errorCorrectionLevel = DEFAULT_VALUES.errorCorrectionLevel;
2321
@Input() margin = DEFAULT_VALUES.margin;
2422
@Input() scale = DEFAULT_VALUES.scale;

tsconfig.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@
1616
"dom"
1717
],
1818
"paths": {
19-
"ngx-qrcode2": [
19+
"@techiediaries/ngx-qrcode": [
2020
"dist/ngx-qrcode"
2121
]
2222
}

0 commit comments

Comments
 (0)