created configuration and base code

README.md

@@ -1,3 +1,34 @@
-# daskeyboard-applet--imap
+# Q alerts for IMAP 
 
-A simple mail-checking applet for the daskeyboard Q-Applets. Unlike the applet that comes with dasKeyboard, this one is an app directed at any IMAP mail account and not limited to a single mail provider such as gmail.
+Notifies of new unread email messages on selected keys.
+
+## Changelog
+
+[CHANGELOG.MD](CHANGELOG.md)
+
+## Istallation
+
+Requires a Das Keyboard Q series: www.daskeyboard.com
+
+Installation, configuration and uninstallation of applets is done within
+the Q Desktop application (<https://www.daskeyboard.com/q>)
+
+## Running tests
+
+- `yarn test` 
+
+## Contributions
+
+Pull requests welcome.
+
+## Copyright / License
+
+Licensed under the GNU General Public License 2.0 (or later);
+you may not use this work except in compliance with the License.
+You may obtain a copy of the License in the LICENSE file, or at:
+   <http://www.gnu.org/licenses/old-licenses/gpl-2.0.txt>
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.