Skip to content

Commit

Permalink
refactor(packaging): rename NPM to @techiediaries/ngx-qrcode
Browse files Browse the repository at this point in the history
rename the NPM package to add organization scope

BREAKING CHANGE: rename this package, @techiediaries/ngx-qrcode must be used instead

Closes #47
  • Loading branch information
Rafa AS committed May 6, 2020
1 parent 6395648 commit 932d26d
Show file tree
Hide file tree
Showing 10 changed files with 34 additions and 32 deletions.
34 changes: 19 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,34 +1,38 @@
# ngx-qrcode2
# @techiediaries/ngx-qrcode

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

`@techiediaries/ngx-qrcode` An Angular Component library for Generating QR (Quick Response ) Codes.

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

>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)
## How to install ngx-qrcode2?
## How to install @techiediaries/ngx-qrcode?

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

```bash
$ npm install ngx-qrcode2 --save
$ npm install @techiediaries/ngx-qrcode --save
or
$ yarn add ngx-qrcode2
$ yarn add @techiediaries/ngx-qrcode
```

## How to use ngx-qrcode2?
## How to use @techiediaries/ngx-qrcode?

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

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


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

```ts
import { BrowserModule } from '@angular/platform-browser';
import { NgModule } from '@angular/core';
import { NgxQRCodeModule } from 'ngx-qrcode2';
import { NgxQRCodeModule } from '@techiediaries/ngx-qrcode';

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

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

<div style="text-align:center">
<h1>
ngx-qrcode2 demo
@techiediaries/ngx-qrcode demo
</h1>
</div>

<ngx-qrcode
[elementType]="elementType"
[value] = "value"
cssClass = "aclass"
errorCorrectionLevel = "L">
[elementType]="elementType"
[value] = "value"
cssClass = "aclass"
errorCorrectionLevel = "L">
</ngx-qrcode>

```
Expand All @@ -85,7 +89,7 @@ export class AppComponent {
```


## How to develop ngx-qrcode2?
## How to develop @techiediaries/ngx-qrcode?

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

Expand Down
6 changes: 3 additions & 3 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "ngx-qrcode2",
"version": "9.0.0",
"name": "@techiediaries/ngx-qrcode",
"version": "9.0.1",
"scripts": {
"ng": "ng",
"start": "ng serve ngx-qrcode-demo",
Expand All @@ -15,7 +15,7 @@
"lib:package": "yarn build && yarn copy:readme",
"prelib:publish": "yarn lib:package",
"lib:publish": "cd ./dist/ngx-qrcode && yarn publish --access=public",
"tags": "yarn tag list ngx-qrcode2"
"tags": "yarn tag list @techiediaries/ngx-qrcode"
},
"repository": {
"type": "git",
Expand Down
3 changes: 1 addition & 2 deletions projects/ngx-qrcode-demo/src/app/app.component.html
Original file line number Diff line number Diff line change
Expand Up @@ -7,5 +7,4 @@
[errorCorrectionLevel]="correctionLevel"
[value]="value"
alt="Demo QR Code"
cssClass="aclass">
</ngx-qrcode>
cssClass="aclass"></ngx-qrcode>
2 changes: 1 addition & 1 deletion projects/ngx-qrcode-demo/src/app/app.component.ts
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import { Component } from '@angular/core';
import { NgxQrcodeElementTypes, NgxQrcodeErrorCorrectionLevels } from 'ngx-qrcode2';
import { NgxQrcodeElementTypes, NgxQrcodeErrorCorrectionLevels } from '@techiediaries/ngx-qrcode';

@Component({
selector: 'app-root',
Expand Down
2 changes: 1 addition & 1 deletion projects/ngx-qrcode-demo/src/app/app.module.ts
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
import { BrowserModule } from '@angular/platform-browser';
import { NgModule } from '@angular/core';

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

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

Expand Down
2 changes: 1 addition & 1 deletion projects/ngx-qrcode-demo/tsconfig.app.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
"outDir": "../../out-tsc/app",
"types": [],
"paths": {
"ngx-qrcode2": [
"@techiediaries/ngx-qrcode": [
"projects/ngx-qrcode/src/public-api.ts"
]
}
Expand Down
2 changes: 1 addition & 1 deletion projects/ngx-qrcode-demo/tsconfig.spec.json
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
"node"
],
"paths": {
"ngx-qrcode2": [
"@techiediaries/ngx-qrcode": [
"projects/ngx-qrcode/src/public-api.ts"
]
}
Expand Down
9 changes: 5 additions & 4 deletions projects/ngx-qrcode/package.json
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
{
"name": "ngx-qrcode2",
"version": "9.0.0",
"description": "An Angular component for generating QRCodes ",
"homepage": "https://www.techiediaries.com/ngx-qrcode",
"name": "@techiediaries/ngx-qrcode",
"version": "9.0.1",
"description": "An Angular component for generating QRCodes",
"homepage": "https://github.com/techiediaries/ngx-qrcode",
"private": false,
"repository": {
"type": "git",
"url": "https://github.com/techiediaries/ngx-qrcode"
Expand Down
4 changes: 1 addition & 3 deletions projects/ngx-qrcode/src/lib/qrcode.component.ts
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,7 @@ import { DEFAULT_VALUES } from './qrcode.constants';

@Component({
selector: 'ngx-qrcode',
template: `
<div #qrcElement [class]="cssClass"></div>`,
template: `<div #qrcElement [class]="cssClass"></div>`,
changeDetection: ChangeDetectionStrategy.OnPush
})
export class QrcodeComponent implements OnChanges {
Expand All @@ -18,7 +17,6 @@ export class QrcodeComponent implements OnChanges {
@Input() alt: string;
@Input() value = DEFAULT_VALUES.value;
@Input() version = DEFAULT_VALUES.version;

@Input() errorCorrectionLevel = DEFAULT_VALUES.errorCorrectionLevel;
@Input() margin = DEFAULT_VALUES.margin;
@Input() scale = DEFAULT_VALUES.scale;
Expand Down
2 changes: 1 addition & 1 deletion tsconfig.json
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
"dom"
],
"paths": {
"ngx-qrcode2": [
"@techiediaries/ngx-qrcode": [
"dist/ngx-qrcode"
]
}
Expand Down

0 comments on commit 932d26d

Please sign in to comment.