Skip to content

Commit

Permalink
change name to prevent trademark vilation issues
Browse files Browse the repository at this point in the history
  • Loading branch information
gugu committed Mar 9, 2024
1 parent fef5aee commit 6ba284e
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 12 deletions.
18 changes: 9 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
# Qreate
# qreator

[![npm version](https://badge.fury.io/js/qreate.svg)](https://badge.fury.io/js/qreate)
[![npm version](https://badge.fury.io/js/qreator.svg)](https://badge.fury.io/js/qreator)

QR Code generator for browser and node.js with tree shaking and logo support

![image](https://github.com/Short-io/qreate/assets/75169/02b84738-56f2-44d8-8d11-f40e263302ed)
![image](https://github.com/Short-io/qreator/assets/75169/02b84738-56f2-44d8-8d11-f40e263302ed)

## Overview

Expand All @@ -16,24 +16,24 @@ QR Code generator for browser and node.js with tree shaking and logo support
- tree shaking support
- browser / node.js

[Releases](https://github.com/Short-io/qreate/releases)
[Releases](https://github.com/Short-io/qreator/releases)

## Installing

```shell
npm install qreate
npm install qreator
# or
yarn add qreate
yarn add qreator
```

## Usage

Example:

```javascript
import { getSVG } from "qreate/lib/svg";
import { getPNG } from "qreate/lib/png"; // imports canvas implementation in browser and sharp module in node.js
import { getPDF } from "qreate/lib/pdf"; // this import is large, consider async import
import { getSVG } from "qreator/lib/svg";
import { getPNG } from "qreator/lib/png"; // imports canvas implementation in browser and sharp module in node.js
import { getPDF } from "qreator/lib/pdf"; // this import is large, consider async import
const svgString = await getSVG("I love QR", {
logo: fs.openFileSync("my-logo.svg"),
color: "#000000",
Expand Down
6 changes: 3 additions & 3 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"name": "qreate",
"name": "qreator",
"version": "9.0.6",
"description": "QR Code generator for browser and node.js with tree shaking and logo support",
"homepage": "https://github.com/Short-io/qr-image",
Expand All @@ -19,9 +19,9 @@
"license": "MIT",
"repository": {
"type": "git",
"url": "https://github.com/Short-io/qreate.git"
"url": "https://github.com/Short-io/qreator.git"
},
"bugs": "https://github.com/Short-io/qreate/issues",
"bugs": "https://github.com/Short-io/qreator/issues",
"type": "module",
"main": "lib/qr.js",
"exports": {
Expand Down

0 comments on commit 6ba284e

Please sign in to comment.