Skip to content

Commit bcbb643

Browse files
iminsoftwareiminsoftware
committed
fix: 添加开发者文档，更新适配机型，以及邮箱
解决方案：NA 影响范围：all 关联工单：NA 更新版本：NA
1 parent e98715c commit bcbb643

7 files changed

Lines changed: 87 additions & 30 deletions

File tree

‎README.md‎

Lines changed: 63 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -13,16 +13,73 @@ npm install react-native-printer-imin
1313
```js
1414
import PrinterImin from 'react-native-printer-imin';
1515

16-
// ...
17-
PrinterImin.initPrinter();
16+
// Initialize printer
17+
await PrinterImin.initPrinter();
1818

19-
PrinterImin.getPrinterStatus().then((info) => {
20-
console.log(info);
21-
});
19+
// Check printer status
20+
const status = await PrinterImin.getPrinterStatus();
21+
console.log(status);
2222

23-
PrinterImin.printText('hello world');
23+
// Print text
24+
await PrinterImin.printText('Hello World');
2425
```
2526

27+
## Documentation
28+
29+
📚 **Complete documentation is available in multiple languages:**
30+
31+
### 🇨🇳 中文文档 (Chinese Documentation)
32+
33+
| Document | Description |
34+
|----------|-------------|
35+
| [📖 文档中心](./docs/README.md) | 主要文档中心 |
36+
| [🚀 快速开始](./docs/quick-start.md) | 5分钟快速上手 |
37+
| [⚙️ 安装指南](./docs/installation-guide.md) | 详细安装配置说明 |
38+
| [📋 API参考](./docs/api-reference.md) | 完整API文档 |
39+
| [👨‍💻 开发者指南](./docs/developer-guide.md) | 深入开发指导 |
40+
| [💡 使用示例](./docs/examples.md) | 实际应用场景示例 |
41+
| [🔄 迁移指南](./docs/migration-guide.md) | 版本升级指导 |
42+
| [❓ 常见问题](./docs/faq.md) | 常见问题解答 |
43+
44+
### 🇺🇸 English Documentation
45+
46+
| Document | Description |
47+
|----------|-------------|
48+
| [📖 Documentation Center](./docs/en/README.md) | Main documentation hub |
49+
| [🚀 Quick Start](./docs/en/quick-start.md) | Get started in 5 minutes |
50+
| [⚙️ Installation Guide](./docs/en/installation-guide.md) | Detailed setup instructions |
51+
| [📋 API Reference](./docs/en/api-reference.md) | Complete API documentation |
52+
| [👨‍💻 Developer Guide](./docs/en/developer-guide.md) | Advanced development guide |
53+
| [❓ FAQ](./docs/en/faq.md) | Frequently asked questions |
54+
55+
### Quick Links
56+
57+
- **Example App**: [example/](./example/)
58+
- **GitHub Issues**: [Report Issues](https://github.com/iminsoftware/react-native-printer-imin/issues)
59+
60+
## Features
61+
62+
- ✅ **Text Printing** - Multiple fonts, styles, and alignments
63+
- ✅ **Image Printing** - URL and local images with size control
64+
- ✅ **QR Code Printing** - Customizable size, error correction, and alignment
65+
- ✅ **Barcode Printing** - Multiple barcode formats supported
66+
- ✅ **Table Printing** - Flexible column layouts
67+
- ✅ **Label Printing** - SDK 2.0 exclusive feature
68+
- ✅ **Device Control** - Paper cutting, cash drawer, status monitoring
69+
70+
## Supported Devices
71+
72+
### Handheld Finance Series
73+
- M2-202, M2-203, M2 Pro
74+
- Swift 1, Swift 2, Swift 2 Pro, Swift 2 Ultra, Swift 1 Pro
75+
76+
### Tablet Terminal Series
77+
- M2 Max, D1, D1 Pro
78+
- Falcon 1, Swan 2, Falcon 2, Falcon 2 Pro, Falcon 1 Pro, Swan 2 Pro
79+
80+
### Desktop POS Equipment
81+
- D4, Swan 2, Falcon 2
82+
2683
## Contributing
2784

2885
See the [contributing guide](CONTRIBUTING.md) to learn how to contribute to the repository and the development workflow.

‎docs/README.md‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,19 +8,19 @@
88

99
**手持金融系列**
1010
- M2-202、M2-203、M2 Pro
11-
- Swift 1、Swift 2、Swift 2 Pro、Swift 2 Ultra
11+
- Swift 1、Swift 2、Swift 2 Pro、Swift 2 Ultra、Swift 1 Pro
1212

1313
**平板终端系列**
1414
- M2 Max、D1、D1 Pro
15-
- Falcon 1、Swan 2、Falcon 2
15+
- Falcon 1、Swan 2、Falcon 2、Falcon 2 Pro、Falcon 1 Pro、Swan 2 Pro
1616

1717
**桌面收银设备**
1818
- D4、Swan 2、Falcon 2
1919

2020
### 打印机规格
2121

2222
iMin产品配备两种内置打印机：
23-
- **80mm纸宽**：带切刀，兼容58mm（如Falcon 1、Falcon 2）
23+
- **80mm纸宽**：带切刀，兼容58mm（如Falcon 1、Falcon 2、Falcon 2 Pro、Falcon 1 Pro、Swan 2 Pro）
2424
- **58mm纸宽**：无切刀（如D1、D1 Pro、M2 Max、Swift系列）
2525

2626
## 快速导航
@@ -107,7 +107,7 @@ await PrinterImin.printQrCode('https://www.imin.sg');
107107

108108
### 联系我们
109109
- **开发团队**: iminsoftware
110-
- **邮箱**: softwareteam@imin.sg
110+
- **邮箱**: huayan.xie@imin.com
111111
- **官网**: https://www.imin.sg
112112

113113
## 许可证

‎docs/developer-guide.md‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,19 +8,19 @@
88

99
**手持金融系列**
1010
- M2-202、M2-203、M2 Pro
11-
- Swift 1、Swift 2、Swift 2 Pro、Swift 2 Ultra
11+
- Swift 1、Swift 2、Swift 2 Pro、Swift 2 Ultra、Swift 1 Pro
1212

1313
**平板终端系列**
1414
- M2 Max、D1、D1 Pro
15-
- Falcon 1、Swan 2、Falcon 2、Falcon 2 Pro、Falcon 1 Pro
15+
- Falcon 1、Swan 2、Falcon 2、Falcon 2 Pro、Falcon 1 Pro、Swan 2 Pro
1616

1717
**桌面收银设备**
1818
- D4、Swan 2、Falcon 2
1919

2020
### 打印机规格
2121

2222
iMin产品配备两种内置打印机：
23-
- **80mm纸宽**：带切刀，兼容58mm（如Falcon 1、Falcon 2、Falcon 2 Pro、Falcon 1 Pro）
23+
- **80mm纸宽**：带切刀，兼容58mm（如Falcon 1、Falcon 2、Falcon 2 Pro、Falcon 1 Pro、Swan 2 Pro）
2424
- **58mm纸宽**：无切刀（如D1、D1 Pro、M2 Max、Swift系列）
2525

2626
## 架构设计
@@ -470,7 +470,7 @@ class PrintQueue {
470470

471471
- **GitHub仓库**: https://github.com/iminsoftware/react-native-printer-imin
472472
- **问题反馈**: https://github.com/iminsoftware/react-native-printer-imin/issues
473-
- **开发团队**: iminsoftware <softwareteam@imin.sg>
473+
- **开发团队**: iminsoftware <huayan.xie@imin.com>
474474

475475
## 许可证
476476

‎docs/en/README.md‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,19 +8,19 @@
88

99
**Handheld Finance Series**
1010
- M2-202, M2-203, M2 Pro
11-
- Swift 1, Swift 2, Swift 2 Pro, Swift 2 Ultra
11+
- Swift 1, Swift 2, Swift 2 Pro, Swift 2 Ultra, Swift 1 Pro
1212

1313
**Tablet Terminal Series**
1414
- M2 Max, D1, D1 Pro
15-
- Falcon 1, Swan 2, Falcon 2
15+
- Falcon 1, Swan 2, Falcon 2, Falcon 2 Pro, Falcon 1 Pro, Swan 2 Pro
1616

1717
**Desktop POS Equipment**
1818
- D4, Swan 2, Falcon 2
1919

2020
### Printer Specifications
2121

2222
iMin products come with two types of built-in printers:
23-
- **80mm paper width**: With cutter, compatible with 58mm (e.g., Falcon 1, Falcon 2)
23+
- **80mm paper width**: With cutter, compatible with 58mm (e.g., Falcon 1, Falcon 2, Falcon 2 Pro, Falcon 1 Pro, Swan 2 Pro)
2424
- **58mm paper width**: Without cutter (e.g., D1, D1 Pro, M2 Max, Swift series)
2525

2626
## Quick Navigation
@@ -107,7 +107,7 @@ await PrinterImin.printQrCode('https://www.imin.sg');
107107

108108
### Contact Us
109109
- **Development Team**: iminsoftware
110-
- **Email**: softwareteam@imin.sg
110+
- **Email**: huayan.xie@imin.com
111111
- **Website**: https://www.imin.sg
112112

113113
## License

‎docs/en/developer-guide.md‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,19 +8,19 @@
88

99
**Handheld Finance Series**
1010
- M2-202, M2-203, M2 Pro
11-
- Swift 1, Swift 2, Swift 2 Pro, Swift 2 Ultra
11+
- Swift 1, Swift 2, Swift 2 Pro, Swift 2 Ultra, Swift 1 Pro
1212

1313
**Tablet Terminal Series**
1414
- M2 Max, D1, D1 Pro
15-
- Falcon 1, Swan 2, Falcon 2
15+
- Falcon 1, Swan 2, Falcon 2, Falcon 2 Pro, Falcon 1 Pro, Swan 2 Pro
1616

1717
**Desktop POS Equipment**
1818
- D4, Swan 2, Falcon 2
1919

2020
### Printer Specifications
2121

2222
iMin products come with two types of built-in printers:
23-
- **80mm paper width**: With cutter, compatible with 58mm (e.g., Falcon 1, Falcon 2、Falcon 2 Pro、Falcon 1 Pro)
23+
- **80mm paper width**: With cutter, compatible with 58mm (e.g., Falcon 1, Falcon 2, Falcon 2 Pro, Falcon 1 Pro, Swan 2 Pro)
2424
- **58mm paper width**: Without cutter (e.g., D1, D1 Pro, M2 Max, Swift series)
2525

2626
## Architecture Design
@@ -470,7 +470,7 @@ class PrintQueue {
470470

471471
- **GitHub Repository**: https://github.com/iminsoftware/react-native-printer-imin
472472
- **Issue Reporting**: https://github.com/iminsoftware/react-native-printer-imin/issues
473-
- **Development Team**: iminsoftware <softwareteam@imin.sg>
473+
- **Development Team**: iminsoftware <huayan.xie@imin.com>
474474

475475
## License
476476

‎docs/en/faq.md‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -82,11 +82,11 @@ const checkDevice = async () => {
8282

8383
**Handheld Finance Series**:
8484
- M2-202, M2-203, M2 Pro
85-
- Swift 1, Swift 2, Swift 2 Pro, Swift 2 Ultra
85+
- Swift 1, Swift 2, Swift 2 Pro, Swift 2 Ultra, Swift 1 Pro
8686

8787
**Tablet Terminal Series**:
8888
- M2 Max, D1, D1 Pro
89-
- Falcon 1, Swan 2, Falcon 2
89+
- Falcon 1, Swan 2, Falcon 2, Falcon 2 Pro, Falcon 1 Pro, Swan 2 Pro
9090

9191
**Desktop POS Equipment**:
9292
- D4, Swan 2, Falcon 2
@@ -174,7 +174,7 @@ try {
174174
} catch (error) {
175175
console.log('Device does not support paper cutting');
176176
// Only devices with cutter support this function
177-
// e.g., Falcon 1, Falcon 2 (80mm version)
177+
// e.g., Falcon 1, Falcon 2, Falcon 2 Pro, Falcon 1 Pro, Swan 2 Pro (80mm version)
178178
}
179179
```
180180

@@ -510,7 +510,7 @@ If the above FAQ doesn't solve your problem, please:
510510
1. Check [GitHub Issues](https://github.com/iminsoftware/react-native-printer-imin/issues)
511511
2. Search existing issues or create a new Issue
512512
3. Provide detailed error information and environment configuration
513-
4. Contact technical support: softwareteam@imin.sg
513+
4. Contact technical support: huayan.xie@imin.com
514514

515515
When submitting an Issue, please include:
516516
- Device model and Android version

‎docs/faq.md‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -82,11 +82,11 @@ const checkDevice = async () => {
8282

8383
**手持金融系列**:
8484
- M2-202, M2-203, M2 Pro
85-
- Swift 1, Swift 2, Swift 2 Pro, Swift 2 Ultra
85+
- Swift 1, Swift 2, Swift 2 Pro, Swift 2 Ultra, Swift 1 Pro
8686

8787
**平板终端系列**:
8888
- M2 Max, D1, D1 Pro
89-
- Falcon 1, Swan 2, Falcon 2
89+
- Falcon 1, Swan 2, Falcon 2, Falcon 2 Pro, Falcon 1 Pro, Swan 2 Pro
9090

9191
**桌面收银设备**:
9292
- D4, Swan 2, Falcon 2
@@ -174,7 +174,7 @@ try {
174174
} catch (error) {
175175
console.log('设备不支持切纸功能');
176176
// 只有带切刀的设备才支持此功能
177-
// 如: Falcon 1, Falcon 2 (80mm版本)
177+
// 如: Falcon 1, Falcon 2, Falcon 2 Pro, Falcon 1 Pro, Swan 2 Pro (80mm版本)
178178
}
179179
```
180180

@@ -510,7 +510,7 @@ const printReceipt = async () => {
510510
1. 查看 [GitHub Issues](https://github.com/iminsoftware/react-native-printer-imin/issues)
511511
2. 搜索已有问题或创建新的Issue
512512
3. 提供详细的错误信息和环境配置
513-
4. 联系技术支持: softwareteam@imin.sg
513+
4. 联系技术支持: huayan.xie@imin.com
514514

515515
提交Issue时请包含：
516516
- 设备型号和Android版本

0 commit comments

Comments
 (0)