Create README.md

2021-02-06 17:17:13 +01:00
parent 68d2432a5a
commit 4e011f9e9d
1 changed files with 27 additions and 0 deletions
@@ -0,0 +1,27 @@
+# DesktopNotifications
+
+A cross-platform C# library for desktop "toast" notifications.
+
+
+# Features
+
+|                          | Windows | Linux (FreeDesktop) | OSX |
+|--------------------------|---------|---------------------|-----|
+| Show notifications  | ✓       | ✓                   | ✕   |
+| Schedule notifications | ✕       | ✕                   | ✕   |
+| Launch actions¹           | ✓       | ✕                   |  ✕   |
+| Replacing notifications                | ✕       | ✕                   |  ✕   |
+| Buttons                  | ✓       | ✓                   |  ✕   |
+| Advanced content (Audio, Images, etc)                  | ✕       | ✕                   |  ✕   |
+
+<sub> ¹ Some platforms support launching your application when the user clicked a notification. The associated action identifier is passed as a command-line argument. </sub>
+
+# Avalonia
+
+The `DesktopNotifications.Avalonia` package offers support for the [Avalonia](https://github.com/AvaloniaUI/Avalonia) project. It doesn't do much on its own, it just provides helpers to register
+the `INotificationManager` with the application builder.
+
+
+# License
+
+See [License](License.md)