From 4cb15aba6c758d95fa5787760adf87eb5f6eb0a6 Mon Sep 17 00:00:00 2001 From: Serubin Date: Sat, 13 May 2017 11:42:21 -0400 Subject: [PATCH] Added readme --- README.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..c002145 --- /dev/null +++ b/README.md @@ -0,0 +1,18 @@ +# PulseSMS Web Client +This project is a remake of the original KlinkerApp PulseSMS web client. It's based on the original Open Source (Apache License) implementation. It aims to help fix some of the short comings of the original app as outlined below under **Features**. + +The original app is located at [messenger.klinkerapps.com](https://messenger.klinkerapps.com/). The current hosted version of this app is located at [pulse.serubin.net](https://pulse.serubin.net). + +## Features +As previously mentioned, this app aims to fix some of the short comings of the original web app. Most notably: +* Faster loading time (Async page loading) +* Better refresh times (Uses a high/low refresh based on page focus) +* New and improved compose new message page. +* Improved logic + +## Privacy +Like the original app, this version does not save any data onto the host server. It's entirely client based. + +## Installation +grunt/grunt-cli is required for installation. Run `npm install` to download the dependencies and then `grunt build` to "compile" the javascript. +