From fd850b27d3454babe19a03cc0b4d12aca1452a82 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Niko=20K=C3=B6ser?= Date: Tue, 26 Jan 2021 10:45:14 +0100 Subject: [PATCH] docs(readme): refactor readme --- README.md | 69 ++++++++++++++++++++++++---------------- assets/gopher-letter.svg | 1 + 2 files changed, 42 insertions(+), 28 deletions(-) create mode 100644 assets/gopher-letter.svg diff --git a/README.md b/README.md index 8b5cc72..2258397 100644 --- a/README.md +++ b/README.md @@ -1,25 +1,39 @@ -

Welcome to notify (WIP) 👋

-

- - GitHub tag (latest SemVer) - - - Lines of code - - - License: MIT - -

+
+notify logo -> A dead simple Go library for sending notifications to various messaging platforms. +![GitHub tag (latest SemVer)](https://img.shields.io/github/v/tag/nikoksr/notify?color=success&label=version&sort=semver) +[![Go Report Card](https://goreportcard.com/badge/github.com/nikoksr/notify)](https://goreportcard.com/report/github.com/nikoksr/notify) +[![Codacy Badge](https://app.codacy.com/project/badge/Grade/2ba9840a93e44e748f6b2fdb19b65b13)](https://www.codacy.com/gh/nikoksr/notify/dashboard?utm_source=github.com&utm_medium=referral&utm_content=nikoksr/notify&utm_campaign=Badge_Grade) +[![Maintainability](https://api.codeclimate.com/v1/badges/b3afd7bf115341995077/maintainability)](https://codeclimate.com/github/nikoksr/notify/maintainability) +[![go.dev reference](https://img.shields.io/badge/go.dev-reference-007d9c?logo=go&logoColor=white&style=flat)](https://pkg.go.dev/github.com/nikoksr/notify) -## Install +
+ +>

A dead simple Go library for sending notifications to various messaging platforms.

+ +

+ +## About + +*Notify* arose from my own need for one of my api server running in production to be able to notify me when, for example, an error occurred. The library is kept as simple as possible to allow a quick integration and easy usage. + +## Disclaimer + +Any misuse of this library is your own liability and responsibility and cannot be attributed to the authors of this library. See [license](LICENSE) for more. + +Spamming through the use of this library **may get you permanently banned** on most supported platforms. + +## Install ```sh go get -u github.com/nikoksr/notify ``` -## Example usage +## Example usage ```go // The notifier we're gonna send our messages to @@ -44,31 +58,30 @@ _ = notifier.Send( ) ``` -## Roadmap +## Roadmap -* [ ] Add tests -* [ ] Add more notification services +- [ ] Add tests +- [ ] Add more notification services -## Libraries in use +## Credits -* [github.com/bwmarrin/discordgo](github.com/bwmarrin/discordgo) -* [github.com/jordan-wright/email](github.com/jordan-wright/email) -* [github.com/go-telegram-bot-api/telegram-bot-api](github.com/go-telegram-bot-api/telegram-bot-api) +- Discord support: [bwmarrin/discordgo](github.com/bwmarrin/discordgo) +- Email support: [jordan-wright/email](github.com/jordan-wright/email) +- Telegram support: [go-telegram-bot-api/telegram-bot-api](github.com/go-telegram-bot-api/telegram-bot-api) +- Logo: [MariaLetta/free-gophers-pack](https://github.com/MariaLetta/free-gophers-pack) -## Author +## Author -👤 **Niko Köser** +**Niko Köser** * Twitter: [@nikoksr](https://twitter.com/nikoksr) * Github: [@nikoksr](https://github.com/nikoksr) -## 🤝 Contributing +## Contributing Contributions, issues and feature requests are welcome!
Feel free to check [issues page](https://github.com/nikoksr/notify/issues). You can also take a look at the [contributing guide](https://github.com/nikoksr/notify/blob/main/CONTRIBUTING.md). -## Show your support +## Show your support Give a ⭐️ if this project helped you! -*** -_This README was generated with ❤️ by [readme-md-generator](https://github.com/kefranabg/readme-md-generator)_ diff --git a/assets/gopher-letter.svg b/assets/gopher-letter.svg new file mode 100644 index 0000000..2e57514 --- /dev/null +++ b/assets/gopher-letter.svg @@ -0,0 +1 @@ + \ No newline at end of file