Skip to content

Commit

Permalink
Update documentations
Browse files Browse the repository at this point in the history
  • Loading branch information
hifocus committed Apr 27, 2024
1 parent 9969317 commit 47ef6cf
Show file tree
Hide file tree
Showing 2 changed files with 52 additions and 26 deletions.
46 changes: 26 additions & 20 deletions README-CN.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<p align="center">
<a href="https://merger.huangxin.org">
<img alt="merger" src="https://ae01.alicdn.com/kf/HTB1M9ondUKF3KVjSZFE760ExFXae.png" height="75">
<img alt="merger" src="https://edge.huangxin.org/images/2024/04/404313540.png" height="75">
</a>
</p>

Expand All @@ -26,25 +26,31 @@

## 特性

- 最少的请求数,最快的加载速度。
- 详尽的代码注释,方便后续开发。
- 结合实际使用场景,为每一种支付方式单独设计的展示样式。
- 高度可定制化,页面上一切内容均可通过预留的 JavasSript 变量更改。无需任何编程技巧,且配置方便。
- 细致入深的用户体验考量;用细心考量,和保持用户体验第一的热情,你和你用户的在配置/使用时的体验,只能用“顺滑”来形容。
- 静态文件在有可能的情况下均通过 CDN 公用库分发,以提供更快的加载速度。

## 相关链接

- [说明文档](https://merger.huangxin.org/cn/categories/docs/)
- [概述](https://merger.huangxin.org/docs/introduction)
- [安装](https://merger.huangxin.org/docs/install)
- [配置](https://merger.huangxin.org/docs/configure)
- [部署](https://merger.huangxin.org/docs/deploy)
- [演示站点](https://qr.huangxin.org)
- [其他演示站点](https://merger.huangxin.org/cn/docs/introduction#%E5%85%B6%E4%BB%96%E6%BC%94%E7%A4%BA%E7%AB%99%E7%82%B9)
- [提交问题](https://github.com/qr-merger/merger/issues)
- [合并请求](https://github.com/qr-merger/merger/pulls)
- [感谢](https://merger.huangxin.org/cn/docs/introduction#%E6%84%9F%E8%B0%A2)
- 支持微信、支付宝和PayPal。
- 当扫描微信(显示支付码)或支付宝(重定向)的URL二维码时,直接引导用户进行支付。
- 支持多语言,有两种模式:`捐赠``支付`
- 提供Gulp支持,增强开发者体验并支持JAMstack部署。
- 静态文件托管于 [cdnjs.com](https://cdnjs.com/libraries/merger),可作为独立的HTML文件运行。

## 使用方法

### 使用 NPM 和 Gulp(推荐)
```bash
git clone https://github.com/qr-merger/merger
cd merger

# 编辑 merger.html

pnpm i
pnpm build
```
优化后的版本将出现在`/build`目录中。适用于 JAMstack 平台,如 [CloudFlare Pages](https://pages.cloudflare.com)[Vercel](https://vercel.com)[Netlify](https://www.netlify.com)

### 独立使用

1. 下载 [merger.html](https://github.com/qr-merger/merger/blob/master/merger.html)
2. 编辑其内容。
3. 根据喜好部署HTML文件。

## 开源许可证

Expand Down
32 changes: 26 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,12 +28,32 @@ This project is sponsored by <a target="_blank" href="https://www.cloudflare.com

## Features

- Fewest number of requests, fastest loading speed.
- Detailed code comments , make ease for further developments.
- Integrate with actual usage scenes, to present a individually-designed style for every single payment method.
- Highly customisable, everthing on the page can be changed through pre-configured JavaScript variables. No need for any programming technique, while being easy to use.
- In-depth user experience considerations; by thinking thoughtfully and having the passion to always keep UX as the first priority, you and your users' experiences when configuring / using merger could only be described as 'shift'.
- The use of public CDN on static files (where applicable) will speed-up the loading.
- Supports WeChat, AliPay and PayPal.
- When scanning QR Code of URL in WeChat (shows payment code) or AliPay (redirects), direct users to pay.
- Multilingual adaption with two modes: `donate` or `payment`.
- Gulp support for developer experience and JAMstack deployment.
- Static files on [cdnjs.com](https://cdnjs.com/libraries/merger). Works as standalone html.

## Usage

### With NPM and Gulp (Recommended)
```bash
git clone https://github.com/qr-merger/merger
cd merger

# Edit merger.html

pnpm i
pnpm build
```
An optimised version will appear at `/build` directory. Works well with JAMstack platforms such as [CloudFlare Pages](https://pages.cloudflare.com), [Vercel](https://vercel.com) and [Netlify](https://www.netlify.com).

### Standalone

1. Download [merger.html](https://github.com/qr-merger/merger/blob/master/merger.html).
2. Edit its contents.
3. Serve the html file per your liking.


## License

Expand Down

0 comments on commit 47ef6cf

Please sign in to comment.