Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/woodruffw/notify.cr
A Crystal library for desktop notifications.
https://github.com/woodruffw/notify.cr
crystal dbus desktop-notifications
Last synced: 14 days ago
JSON representation
A Crystal library for desktop notifications.
- Host: GitHub
- URL: https://github.com/woodruffw/notify.cr
- Owner: woodruffw
- License: other
- Created: 2018-06-18T13:54:59.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2024-04-12T14:07:39.000Z (9 months ago)
- Last Synced: 2024-12-19T10:17:30.349Z (15 days ago)
- Topics: crystal, dbus, desktop-notifications
- Language: Crystal
- Homepage: https://woodruffw.github.io/notify.cr/
- Size: 33.2 KB
- Stars: 14
- Watchers: 4
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
notify.cr
=========
[](https://github.com/woodruffw/notify.cr/actions?query=workflow%3ACI)
A Crystal library for
[Desktop Notifications](http://www.galago-project.org/specs/notification/0.9/index.html) compatible
notification daemons. Uses DBus internally.
**Important**: Platforms with notification systems that don't use DBus/Desktop Notifications are
currently **not supported**. If you'd like support for one of these platforms (e.g., macOS and
Windows), please contribute one!
## Installation
Add this to your application's `shard.yml`:
```yaml
dependencies:
notify:
github: woodruffw/notify.cr
```
## Usage
```crystal
require "notify"
notifier = Notify.new
notifier.notify "hello", body: "world!"
```
## Contributing
1. Fork it ()
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -am 'Add some feature'`)
4. Push to the branch (`git push origin my-new-feature`)
5. Create a new Pull Request
## Contributors
- [woodruffw](https://github.com/woodruffw) William Woodruff - creator, maintainer