Skip to content

Commit

Permalink
Merge pull request #38 from Intosoft/feat/web
Browse files Browse the repository at this point in the history
chore: renamed npm package for better seo
  • Loading branch information
sakul-budhathoki authored Jun 10, 2024
2 parents 1fd1d50 + c3fb4fa commit c09b7ab
Show file tree
Hide file tree
Showing 3 changed files with 16 additions and 19 deletions.
25 changes: 11 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,6 @@
# Deprecated by `npm i @intosoft/qrcode`
# Depreacted by https://github.com/Intosoft/qrcode
# [Intosoft QRCode](https://custoqr.com/) · [![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/Intosoft/qrcode/blob/main/LICENSE)

# [Intosoft CustoQR](https://custoqr.com/) · [![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/Intosoft/qrcode/blob/main/LICENSE)

Intosoft CustoQR is a fully customizable open source QR code generator tool.
Intosoft QRCode is a fully customizable open source QR code generator tool.

- **Versatile and Customizable:** Fully color, style, content customization
- **Seamless Integration:** Integrate Intosoft QRcode seamlessly into your existing tech stack, whether you're working with React, React Native, NodeJS, Vue.js, Angular, or pure JavaScript.
Expand All @@ -16,21 +13,21 @@ Intosoft CustoQR is a fully customizable open source QR code generator tool.
NPM

```
npm i @intosoft/custoqr
npm i @intosoft/qrcode
```

Yarn

```
yarn add @intosoft/custoqr
yarn add @intosoft/qrcode
```

## Examples

React

```jsx
import { generateSVGString } from '@intosoft/custoqr';
import { generateSVGString } from '@intosoft/qrcode';

const config = {}; // Paste config here
const svgString = generateSVGString(config);
Expand All @@ -46,7 +43,7 @@ First Install [react-native-svg](https://github.com/software-mansion/react-nativ

```jsx
import { SvgFromXml } from 'react-native-svg';
import { generateSVGString } from '@intosoft/custoqr';
import { generateSVGString } from '@intosoft/qrcode';

const config = {}; // Paste config here
const svgString = generateSVGString(config);
Expand All @@ -64,7 +61,7 @@ Vanilla JS
<body>
<div id="svg-container"></div>
</body>
<script src="https://unpkg.com/@intosoft/custoqr@0.0.8/dist/iife/index.js"></script>
<script src="https://unpkg.com/@intosoft/qrcode@0.0.8/dist/iife/index.js"></script>
<script>
window.addEventListener("load", function () {
const config = {}; //paste config here
Expand All @@ -79,7 +76,7 @@ VueJS
```vue
<script lang="ts">
import { defineComponent, ref, onMounted } from 'vue';
import { generateSVGString } from '@intosoft/custoqr';
import { generateSVGString } from '@intosoft/qrcode';
export default defineComponent({
setup() {
Expand Down Expand Up @@ -107,7 +104,7 @@ Angular
import { Component,ChangeDetectorRef } from '@angular/core';
import { DomSanitizer, SafeHtml, } from '@angular/platform-browser';
import { RouterOutlet } from '@angular/router';
import { generateSVGString } from '@intosoft/custoqr';
import { generateSVGString } from '@intosoft/qrcode';

@Component({
selector: 'app-root',
Expand All @@ -131,10 +128,10 @@ export class AppComponent {

NodeJs
```js
const custoqr = require("@intosoft/custoqr");
const qrcode = require("@intosoft/qrcode");

const config = {}; // paste config here
const svgString = custoqr.generateSVGString(config);
const svgString = qrcode.generateSVGString(config);
```


Expand Down
8 changes: 4 additions & 4 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
{
"name": "@intosoft/custoqr",
"version": "0.0.9",
"name": "@intosoft/qrcode",
"version": "0.0.1",
"description": "The best tool for QR Code generation in JavaScript (React, React Native, Node.js, VueJS, Angular, JQuery, VanillaJS)",
"main": "./dist/index.js",
"module": "./dist/esm/index.js",
"types": "./dist/index.d.ts",
"homepage": "https://github.com/Intosoft/custoqr",
"homepage": "https://github.com/Intosoft/qrcode",
"repository": {
"type": "git",
"url": "git+https://github.com/Intosoft/custoqr.git"
"url": "git+https://github.com/Intosoft/qrcode.git"
},
"scripts": {
"build": "rimraf ./dist && tsup",
Expand Down
2 changes: 1 addition & 1 deletion src/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -13,5 +13,5 @@ export default {
if (typeof window !== 'undefined') {
// @ts-ignore
// eslint-disable-next-line no-undef
window.custoqr = { generateSVGString, generateContentString };
window.qrcode = { generateSVGString, generateContentString };
}

0 comments on commit c09b7ab

Please sign in to comment.