Add README

Author: electerious

README.md

@@ -0,0 +1,59 @@
+<div align="center">
+
+<img src="https://s.electerious.com/images/ackee-bitbar/icon.png" title="Ackee" alt="Ackee logo" width="128">
+
+# ackee-bitbar
+
+[![Donate via PayPal](https://img.shields.io/badge/paypal-donate-009cde.svg)](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=CYKBESW577YWE)
+
+[BitBar](https://github.com/matryer/bitbar) plugin that displays an overview of your current Ackee stats in the macOS menu bar.
+
+<br/>
+
+![The Ackee plugin in a menu bar](https://s.electerious.com/images/ackee-bitbar/readme.png)
+
+</div>
+
+## 🚀 Get started
+
+### 1) Grab the project
+
+```sh
+git clone https://github.com/electerious/ackee-bitbar.git
+```
+
+### 2) Create a configuration
+
+```sh
+cd ackee-bitbar
+vim .env
+```
+
+```
+ACKEE_ENDPOINT=https://example.com/api
+ACKEE_TOKEN=5c5411b0-ef80-425b-8e80-e8c4a76fcad6
+```
+
+### 3) Add the plugin to BitBar
+
+```
+ln -s index.js ../BitBar/Plugins/Enabled/ackee-bitbar.5m.js
+```
+
+## 💭 FAQ
+
+### The plugin shows `env: No such file or directory`
+
+BitBar [requires that the script contains a shebang](https://github.com/matryer/bitbar#tested-languages) that points to your node binary. `ackee-bitbar` defaults to `/usr/local/bin/node`. You might need to adjust the path at the top of the `index.js`.
+
+### Where can I get my Ackee token?
+
+There's currently no way to create a token in the interface of Ackee, but you can use the API to [generate a new token](https://github.com/electerious/Ackee/blob/master/docs/API.md#creating-a-token).
+
+### How long is the token valid?
+
+The generated token is only valid for a limited time. Adjust the [TTL](https://github.com/electerious/Ackee/blob/master/docs/Options.md#ttl) option of your Ackee instance to stay signed in.
+
+### Is is possible to adjust the refresh interval?
+
+[Sure](https://github.com/matryer/bitbar#using-symlinks). Simply change the `5m` in the symlink filename to `1h`, `1m`, `30s` or the refresh timing of your choice.