Skip to content

Commit aeebabd

Browse files
committed
docs(readme): minor changes
1 parent b19bad2 commit aeebabd

File tree

1 file changed

+6
-10
lines changed

1 file changed

+6
-10
lines changed

README.md

Lines changed: 6 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@
1515

1616
> <p align="center">A dead simple Go library for sending notifications to various messaging services.</p>
1717
18+
> [!NOTE]
1819
> **[July 2024 Update]**: Notify is back under active maintenance! [Read the full announcement here](https://github.com/nikoksr/notify/discussions/840).
1920
2021
<h1></h1>
@@ -67,8 +68,6 @@ In this example, we use the global `Send()` function. Similar to most logging li
6768
libraries, we also recommend avoiding the use of global functions as much as possible. Instead, use one of our versatile
6869
constructor functions to create a new local `Notify` instance and pass it down the stream.
6970

70-
Read the [library docs](https://pkg.go.dev/github.com/nikoksr/notify#section-documentation) for more information.
71-
7271
## Contributing <a id="contributing"></a>
7372

7473
Yes, please! Contributions of all kinds are very welcome! Feel free to check our [open issues](https://github.com/nikoksr/notify/issues). Please also take a look at the [contribution guidelines](https://github.com/nikoksr/notify/blob/main/CONTRIBUTING.md).
@@ -88,7 +87,7 @@ Yes, please! Contributions of all kinds are very welcome! Feel free to check our
8887
| [Discord](https://discord.com) | [service/discord](service/discord) | [bwmarrin/discordgo](https://github.com/bwmarrin/discordgo) | :heavy_check_mark: |
8988
| [Email](https://wikipedia.org/wiki/Email) | [service/mail](service/mail) | [jordan-wright/email](https://github.com/jordan-wright/email) | :heavy_check_mark: |
9089
| [Firebase Cloud Messaging](https://firebase.google.com/docs/cloud-messaging) | [service/fcm](service/fcm) | [appleboy/go-fcm](https://github.com/appleboy/go-fcm) | :heavy_check_mark: |
91-
| [Google Chat](https://workspace.google.com/intl/en/products/chat/) | [service/googlechat](service/googlechat) | [googleapis/google-api-go-client](https://google.golang.org/api/chat/v1) | :heavy_check_mark: |
90+
| [Google Chat](https://workspace.google.com/intl/en/products/chat/) | [service/googlechat](service/googlechat) | [googleapis/google-api-go-client](https://google.golang.org/api/chat/v1) | :heavy_check_mark: |
9291
| [HTTP](https://wikipedia.org/wiki/Hypertext_Transfer_Protocol) | [service/http](service/http) | - | :heavy_check_mark: |
9392
| [Lark](https://www.larksuite.com/) | [service/lark](service/lark) | [go-lark/lark](https://github.com/go-lark/lark) | :heavy_check_mark: |
9493
| [Line](https://line.me) | [service/line](service/line) | [line/line-bot-sdk-go](https://github.com/line/line-bot-sdk-go) | :heavy_check_mark: |
@@ -123,13 +122,10 @@ Yes, please! Contributions of all kinds are very welcome! Feel free to check our
123122

124123
The [logo](https://github.com/MariaLetta/free-gophers-pack) was made by the amazing [MariaLetta](https://github.com/MariaLetta).
125124

126-
## Similar projects <a id="similar_projects"></a>
127-
128-
> Just to clarify, Notify was not inspired by any other project. I created it as a tiny subpackage of a larger project and only later decided to make it a standalone project. In this section I just want to mention other great projects.
125+
## Support <a id="support"></a>
129126

130-
- [containrrr/shoutrrr](https://github.com/containrrr/shoutrrr)
131-
- [caronc/apprise](https://github.com/caronc/apprise)
127+
If you find this project useful, consider giving it a ⭐️! Your support helps bring more attention to the project, allowing us to enhance it even further.
132128

133-
## Show your support <a id="support"></a>
129+
While you're here, feel free to check out my other work:
134130

135-
Please give a ⭐️ if you like the project! It draws more attention to the project, which helps us improve it even faster.
131+
- [nikoksr/konfetty](https://github.com/nikoksr/konfetty) - Zero-dependency, type-safe and powerful post-processing for your existing config solution in Go.

0 commit comments

Comments
 (0)