Skip to content

Commit

Permalink
update module name
Browse files Browse the repository at this point in the history
  • Loading branch information
gugu committed Mar 9, 2024
1 parent c1e214c commit 8cb42aa
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 11 deletions.
18 changes: 9 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
# Qreate

[![npm version](https://badge.fury.io/js/%40shortcm%2Fqr-image.svg)](https://badge.fury.io/js/%40shortcm%2Fqr-image)
[![npm version](https://badge.fury.io/js/qreate.svg)](https://badge.fury.io/js/qreate)

QR Code generator for browser and node.js with tree shaking and logo support (based on [alexeyten/qr-image](https://github.com/alexeyten/qr-image)).
QR Code generator for browser and node.js with tree shaking and logo support

![image](https://github.com/Short-io/qr-image/assets/75169/02b84738-56f2-44d8-8d11-f40e263302ed)
![image](https://github.com/Short-io/qreate/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 (ba
- tree shaking support
- browser / node.js

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

## Installing

```shell
npm install @shortcm/qr-image
npm install qreate
# or
yarn add @shortcm/qr-image
yarn add qreate
```

## Usage

Example:

```javascript
import { getSVG } from "@shortcm/qr-image/lib/svg";
import { getPNG } from "@shortcm/qr-image/lib/png"; // imports canvas implementation in browser and sharp module in node.js
import { getPDF } from "@shortcm/qr-image/lib/pdf"; // this import is large, consider async import
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
const svgString = await getSVG("I love QR", {
logo: fs.openFileSync("my-logo.svg"),
color: "#000000",
Expand Down
4 changes: 2 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@shortcm/qr-image",
"version": "9.0.4",
"name": "qreate",
"version": "9.0.5",
"description": "QR Code generator for browser and node.js with tree shaking and logo support",
"homepage": "https://github.com/Short-io/qr-image",
"keywords": [
Expand Down

0 comments on commit 8cb42aa

Please sign in to comment.