Skip to content

Commit f6e6c0c

Browse files
committed
Update README.md
1 parent dd3f003 commit f6e6c0c

File tree

2 files changed

+108
-13
lines changed

2 files changed

+108
-13
lines changed

README-ZH.md

Lines changed: 99 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,99 @@
1+
# local_notifier
2+
3+
[![pub version][pub-image]][pub-url] [![][discord-image]][discord-url]
4+
5+
[pub-image]: https://img.shields.io/pub/v/local_notifier.svg
6+
[pub-url]: https://pub.dev/packages/local_notifier
7+
8+
[discord-image]: https://img.shields.io/discord/884679008049037342.svg
9+
[discord-url]: https://discord.gg/zPa6EZ2jqb
10+
11+
这个插件允许 Flutter **桌面** 应用显示本地通知。
12+
13+
---
14+
15+
[English](./README.md) | 简体中文
16+
17+
---
18+
19+
<!-- START doctoc generated TOC please keep comment here to allow auto update -->
20+
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
21+
22+
- [local_notifier](#local_notifier)
23+
- [平台支持](#平台支持)
24+
- [快速开始](#快速开始)
25+
- [安装](#安装)
26+
- [⚠️ Linux requirements](#️-linux-requirements)
27+
- [用法](#用法)
28+
- [谁在用使用它?](#谁在用使用它)
29+
- [API](#api)
30+
- [LocalNotifier](#localnotifier)
31+
- [许可证](#许可证)
32+
33+
<!-- END doctoc generated TOC please keep comment here to allow auto update -->
34+
35+
## 平台支持
36+
37+
| Linux | macOS | Windows |
38+
| :---: | :---: | :-----: |
39+
| ✔️ | ✔️ ||
40+
41+
## 快速开始
42+
43+
### 安装
44+
45+
将此添加到你的软件包的 pubspec.yaml 文件:
46+
47+
```yaml
48+
dependencies:
49+
local_notifier: ^0.0.1
50+
```
51+
52+
53+
54+
```yaml
55+
dependencies:
56+
local_notifier:
57+
git:
58+
url: https://github.com/leanflutter/local_notifier.git
59+
ref: main
60+
```
61+
62+
#### ⚠️ Linux requirements
63+
64+
- `libnotify`
65+
66+
运行以下命令
67+
68+
```
69+
sudo apt-get install libnotify-dev
70+
```
71+
72+
### 用法
73+
74+
```dart
75+
LocalNotification notification = LocalNotification(
76+
title: "local_notifier_example",
77+
subtitle: "subtitle",
78+
body: "hello flutter!",
79+
);
80+
await localNotifier.notify(notification);
81+
```
82+
83+
> 请看这个插件的示例应用,以了解完整的例子。
84+
85+
## 谁在用使用它?
86+
87+
- [Biyi (比译)](https://biyidev.com/) - 一个便捷的翻译和词典应用。
88+
89+
## API
90+
91+
### LocalNotifier
92+
93+
| Method | Description | Linux | macOS | Windows |
94+
| -------- | ----------- | ----- | ----- | ------- |
95+
| `notify` | - | ✔️ | ✔️ ||
96+
97+
## 许可证
98+
99+
[MIT](./LICENSE)

README.md

Lines changed: 9 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,18 @@
11
# local_notifier
22

3-
[![pub version][pub-image]][pub-url]
3+
[![pub version][pub-image]][pub-url] [![][discord-image]][discord-url]
44

55
[pub-image]: https://img.shields.io/pub/v/local_notifier.svg
66
[pub-url]: https://pub.dev/packages/local_notifier
77

8-
This plugin allows Flutter **desktop** apps to notify local notifications.
8+
[discord-image]: https://img.shields.io/discord/884679008049037342.svg
9+
[discord-url]: https://discord.gg/zPa6EZ2jqb
910

10-
[![Discord](https://img.shields.io/badge/discord-%237289DA.svg?style=for-the-badge&logo=discord&logoColor=white)](https://discord.gg/zPa6EZ2jqb)
11+
This plugin allows Flutter **desktop** apps to displaying local notifications.
12+
13+
---
14+
15+
English | [简体中文](./README-ZH.md)
1116

1217
---
1318

@@ -21,7 +26,6 @@ This plugin allows Flutter **desktop** apps to notify local notifications.
2126
- [⚠️ Linux requirements](#️-linux-requirements)
2227
- [Usage](#usage)
2328
- [Who's using it?](#whos-using-it)
24-
- [Discussion](#discussion)
2529
- [API](#api)
2630
- [LocalNotifier](#localnotifier)
2731
- [License](#license)
@@ -80,15 +84,7 @@ await localNotifier.notify(notification);
8084
8185
## Who's using it?
8286

83-
- [Biyi (比译)](https://biyidev.com/) - A convenient translation and dictionary app written in dart / Flutter.
84-
85-
## Discussion
86-
87-
> Welcome to join the discussion group to share your suggestions and ideas with me.
88-
89-
- WeChat Group 请添加我的微信 `lijy91`,并备注 `LeanFlutter`
90-
- [QQ Group](https://jq.qq.com/?_wv=1027&k=e3kwRnnw)
91-
- [Telegram Group](https://t.me/leanflutter)
87+
- [Biyi (比译)](https://biyidev.com/) - A convenient translation and dictionary app.
9288

9389
## API
9490

0 commit comments

Comments
 (0)