Created readme.md

Reddit Notify
=========

Reddit Notify is a desktop notification system for Reddit.com

---




> Reddit Notify is designed to allow simply desktop notification from
> Reddit directly on a users desktop.

Version
----

1.0

Acknowledgements
-----------

JTP is developed using the following technolegy

* [EclipseIDE] - A Java IDE.
* [JReddit] - Java wrapper for Reddit
* [DeskNotify] - Desktop Notification Library for Java

Installation
--------------
<b> DOWNLOAD SOURCE </b>
```
    > Download .ZIP or Clone from GitHub Respitory
    > Install to your eclipse IDE
    > Edit Source & Recompile
```
---
<b> DOWNLOAD JAR </b>
```
    > Download .JAR package
    > Extract & Configure redditnotify.ini
    > Run 
```

Configuration
-------------
<b> redditnotify.ini </b>

```
    user = Reddit Username Here 
    pass = Reddit Password Here
```


License
----

MIT
Copyright (C) 2014 Matthew Allen

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.


[EclipseIDE]:https://www.eclipse.org/
[JReddit]:https://github.com/karan/jReddit
[DeskNotify]:https://github.com/Daz44/DeskNotify