Skip to content

Commit 6f47e33

Browse files
authored
Merge pull request #81 from x-hw/readme
[chg] update readme
2 parents 8f4f6ce + 96dfafe commit 6f47e33

File tree

2 files changed

+27
-23
lines changed

2 files changed

+27
-23
lines changed

README-cn.md

+16-15
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,7 @@
44

55
[![](https://img.shields.io/badge/GitHub-x.hw-blue?logo=github)](https://github.com/x-hw) ![GitHub Sponsors](https://img.shields.io/github/sponsors/x-hw?logo=github-sponsors&labelColor=pink&color=white) [![wechatpay](https://img.shields.io/badge/微信打赏--brightgreen?logo=wechat&logoColor=ffffff&labelColor=brightgreen)](#请杯咖啡--打赏) [![alipay](https://img.shields.io/badge/支付宝打赏--blue?logo=alipay&logoColor=ffffff&labelColor=blue)](#请杯咖啡--打赏)
66

7-
[*back to English*](https://github.com/hwxhw/amzqr/blob/master/README.md)
8-
7+
[*back to English*](https://github.com/x-hw/amazing-qr/blob/master/README.md)
98

109
## 概述
1110

@@ -31,15 +30,15 @@
3130

3231
## 示例
3332

34-
![](https://github.com/hwxhw/amazing-qr/blob/master/example/qrs0.jpg)
33+
![](https://github.com/x-hw/amazing-qr/blob/master/example/qrs0.jpg)
3534

36-
![](https://github.com/hwxhw/amazing-qr/blob/master/example/qrs1.jpg)
35+
![](https://github.com/x-hw/amazing-qr/blob/master/example/qrs1.jpg)
3736

38-
![](https://github.com/hwxhw/amazing-qr/blob/master/example/qrs2.jpg)
37+
![](https://github.com/x-hw/amazing-qr/blob/master/example/qrs2.jpg)
3938

40-
![](https://github.com/hwxhw/amazing-qr/blob/master/example/c_qrcode.gif)![](https://github.com/hwxhw/amazing-qr/blob/master/example/daftpunktocat-guy_qrcode.gif)
39+
![](https://github.com/x-hw/amazing-qr/blob/master/example/c_qrcode.gif)![](https://github.com/x-hw/amazing-qr/blob/master/example/daftpunktocat-guy_qrcode.gif)
4140

42-
![](https://github.com/hwxhw/amazing-qr/blob/master/example/zootopia_qrcode.gif)![](https://github.com/hwxhw/amazing-qr/blob/master/example/daftpunktocat-guy_qrcode0.gif)
41+
![](https://github.com/x-hw/amazing-qr/blob/master/example/zootopia_qrcode.gif)![](https://github.com/x-hw/amazing-qr/blob/master/example/daftpunktocat-guy_qrcode0.gif)
4342

4443

4544
## 安装
@@ -73,7 +72,7 @@ amzqr Words
7372

7473
#### 普通二维码
7574

76-
![](https://github.com/hwxhw/amzqr/blob/master/example/0.png)
75+
![](https://github.com/x-hw/amzqr/blob/master/example/0.png)
7776

7877
```markdown
7978
#1 Words
@@ -110,9 +109,9 @@ amzqr https://github.com -n github_qr.jpg -d .../paths/
110109

111110
`-d` 控制位置。
112111

113-
#### 艺术二维码
112+
#### 艺术二维码
114113

115-
![](https://github.com/hwxhw/amazing-qr/blob/master/example/1.png)![](https://github.com/hwxhw/amazing-qr/blob/master/example/2.png)
114+
![](https://github.com/x-hw/amazing-qr/blob/master/example/1.png)![](https://github.com/x-hw/amazing-qr/blob/master/example/2.png)
116115

117116
```markdown
118117
#1 -p
@@ -139,7 +138,7 @@ amzqr https://github.com -p github.jpg [-c] -con 1.5 -bri 1.6
139138

140139
#### 动态GIF二维码
141140

142-
![](https://github.com/hwxhw/amazing-qr/blob/master/example/daftpunktocat-guy_qrcode.gif)![](https://github.com/hwxhw/amazing-qr/blob/master/example/daftpunktocat-guy_qrcode0.gif)
141+
![](https://github.com/x-hw/amazing-qr/blob/master/example/daftpunktocat-guy_qrcode.gif)![](https://github.com/x-hw/amazing-qr/blob/master/example/daftpunktocat-guy_qrcode0.gif)
143142

144143
动态二维码与上述的带图片的二维码的生成方法没什么区别,你只要采用 `.gif` 格式的图片即可生成黑白或者彩色的动态二维码。但**注意**如果使用了 `-n` 参数自定义输出的文件名,切记其格式也必须是 `.gif` 格式。
145144

@@ -184,9 +183,9 @@ Optional parameters
184183

185184
* 建议在图片尺寸大的时候使用 `-v` 的值也应该**适当**变大。
186185

187-
* 如果图片有透明无色部分,最终效果是:![](https://github.com/hwxhw/amazing-qr/blob/master/example/aa.png)
186+
* 如果图片有透明无色部分,最终效果是:![](https://github.com/x-hw/amazing-qr/blob/master/example/aa.png)
188187

189-
你可以将透明部分修改成白色,最终效果会变成![](https://github.com/hwxhw/amazing-qr/blob/master/example/a0.png)
188+
你可以将透明部分修改成白色,最终效果会变成![](https://github.com/x-hw/amazing-qr/blob/master/example/a0.png)
190189

191190
## 可用字符
192191

@@ -211,9 +210,11 @@ Optional parameters
211210
## 请杯咖啡 / 打赏
212211

213212
微信:
214-
![wechatpay](https://github.com/hwxhw/amazing-qr/blob/master/example/wechatpay.jpg)
213+
214+
<img src="https://github.com/x-hw/amazing-qr/blob/master/example/wechatpay.jpg" width = "124" height = "116" alt="wechatpay" align=center />
215215

216216
or
217217

218218
支付宝:
219-
![alipay](https://github.com/hwxhw/amazing-qr/blob/master/example/alipay-qrcode.png)
219+
220+
<img src="https://github.com/x-hw/amazing-qr/blob/master/example/alipay_qrcode.png" width = "132" height = "132" alt="alipay" align=center />

README.md

+11-8
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,8 @@
44

55
[![](https://img.shields.io/badge/GitHub-x.hw-blue?logo=github)](https://github.com/x-hw) ![GitHub Sponsors](https://img.shields.io/github/sponsors/x-hw?logo=github-sponsors&labelColor=pink&color=white) [![wechatpay](https://img.shields.io/badge/sponsor_by_wechat--brightgreen?logo=wechat&logoColor=ffffff&labelColor=brightgreen)](#buy-me-a-coffee--sponsor) [![alipay](https://img.shields.io/badge/sponsor_by_alipay--blue?logo=alipay&logoColor=ffffff&labelColor=blue)](#buy-me-a-coffee--sponsor)
66

7-
[*转到中文版*](https://github.com/hwxhw/amzqr/blob/master/README-cn.md)
7+
8+
[*转到中文版*](https://github.com/x-hw/amazing-qr/blob/master/README-cn.md)
89

910
## Overview
1011

@@ -72,7 +73,7 @@ amzqr Words
7273

7374
#### Common QR-Code
7475

75-
![](https://github.com/hwxhw/amazing-qr/blob/master/example/0.png)
76+
![](https://github.com/x-hw/amazing-qr/blob/master/example/0.png)
7677

7778
```markdown
7879
#1 Words
@@ -114,7 +115,7 @@ amzqr https://github.com -n github_qr.jpg -d .../paths/
114115

115116
#### Artistic QR-Code
116117

117-
![](https://github.com/hwxhw/amazing-qr/blob/master/example/1.png)![](https://github.com/hwxhw/amazing-qr/blob/master/example/2.png)
118+
![](https://github.com/x-hw/amazing-qr/blob/master/example/1.png)![](https://github.com/x-hw/amazing-qr/blob/master/example/2.png)
118119

119120

120121
```markdown
@@ -149,7 +150,7 @@ amzqr https://github.com -p github.jpg [-c] -con 1.5 -bri 1.6
149150

150151
#### Animated GIF QR-Code
151152

152-
![](https://github.com/hwxhw/amazing-qr/blob/master/example/daftpunktocat-guy_qrcode.gif)![](https://github.com/hwxhw/amazing-qr/blob/master/example/daftpunktocat-guy_qrcode0.gif)
153+
![](https://github.com/x-hw/amazing-qr/blob/master/example/daftpunktocat-guy_qrcode.gif)![](https://github.com/x-hw/amazing-qr/blob/master/example/daftpunktocat-guy_qrcode0.gif)
153154

154155
The only difference from Artistic QR-Code mentioned above is that you should input an image file in the `.gif` format. The you can get your black-and-white or colorful qr-code. Remember that when you use `-n` to customize the output-filename, then the output-filename must end by `.gif`.
155156

@@ -197,9 +198,9 @@ Optional parameters
197198

198199
* If the size of the picture is large, you should also choose a **rightly** large `-v` instead of using the default one.
199200

200-
* If part of the picture is transparent, the qr code will look like: ![](https://github.com/hwxhw/amazing-qr/blob/master/example/aa.png)
201+
* If part of the picture is transparent, the qr code will look like: ![](https://github.com/x-hw/amazing-qr/blob/master/example/aa.png)
201202

202-
You can change the transparent layer to white, and then it will look like: ![](https://github.com/hwxhw/amazing-qr/blob/master/example/a0.png)
203+
You can change the transparent layer to white, and then it will look like: ![](https://github.com/x-hw/amazing-qr/blob/master/example/a0.png)
203204

204205
## Supported Characters
205206

@@ -224,9 +225,11 @@ Optional parameters
224225
## Buy me a coffee / Sponsor
225226

226227
wechat:
227-
![wechatpay](https://github.com/hwxhw/amazing-qr/blob/master/example/wechatpay.jpg)
228+
229+
<img src="https://github.com/x-hw/amazing-qr/blob/master/example/wechatpay.jpg" width = "124" height = "116" alt="wechatpay" align=center />
228230

229231
or
230232

231233
alipay:
232-
![alipay](https://github.com/hwxhw/amazing-qr/blob/master/example/alipay-qrcode.png)
234+
235+
<img src="https://github.com/x-hw/amazing-qr/blob/master/example/alipay_qrcode.png" width = "132" height = "132" alt="alipay" align=center />

0 commit comments

Comments
 (0)