Skip to content

Commit

Permalink
Update readme to point to documentation portal
Browse files Browse the repository at this point in the history
  • Loading branch information
GeertvanHorrik committed Jun 8, 2017
1 parent 70edab7 commit 5e4ab55
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 30 deletions.
38 changes: 8 additions & 30 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,35 +1,13 @@
Orc.Notifications
==================
=================

[![Join the chat at https://gitter.im/WildGums/Orc.Notifications](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/WildGums/Orc.Notifications?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)

![License](https://img.shields.io/github/license/wildgums/orc.notifications.svg)
![NuGet downloads](https://img.shields.io/nuget/dt/orc.notifications.svg)
![Version](https://img.shields.io/nuget/v/orc.notifications.svg)
![Pre-release version](https://img.shields.io/nuget/vpre/orc.notifications.svg)
Name|Badge
---|---
Chat|[![Join the chat at https://gitter.im/WildGums/Orc.Notifications](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/WildGums/Orc.Notifications?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
Downloads|![NuGet downloads](https://img.shields.io/nuget/dt/orc.notifications.svg)
Stable version|![Version](https://img.shields.io/nuget/v/orc.notifications.svg)
Unstable version|![Pre-release version](https://img.shields.io/nuget/vpre/orc.notifications.svg)

This library is used to create and display desktop notifications. Notification looks like popup windows and will appear on the top right corner of the screen.

Notifications can be used to briefly display important information to the user.

![Notification](doc/images/Notification.gif)

In order to create notifications in your application use IOC with the *INotificationService* interface.

A default *Notification* class, which implements the *INotification* interface is provided.

```c#
public interface INotification
{
string Title { get; set; }
string Message { get; set; }
ICommand Command { get; set; }
TimeSpan ShowTime { get; set; }
SolidColorBrush BorderBrush { get; set; }
SolidColorBrush BackgroundBrush { get; set; }
SolidColorBrush FontBrush { get; set; }
}
```



For documentation, please visit the [documentation portal](http://opensource.wildgums.com)
Binary file removed doc/images/Notification.gif
Binary file not shown.
Binary file removed doc/images/Notifications_01.png
Binary file not shown.

0 comments on commit 5e4ab55

Please sign in to comment.