From ff81924e2d68af6acf32b7e5209ceddabd2ee794 Mon Sep 17 00:00:00 2001
From: Luna <git@l4.pm>
Date: Thu, 6 Jun 2019 14:25:37 -0300
Subject: [PATCH] add README.md, update AUTHORS

---
 AUTHORS   |  12 ++++--
 README.md | 112 ++++++++++++++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 120 insertions(+), 4 deletions(-)
 create mode 100644 README.md

diff --git a/AUTHORS b/AUTHORS
index 7d24d9b..c206bb1 100644
--- a/AUTHORS
+++ b/AUTHORS
@@ -1,14 +1,18 @@
-WakaTime is written and maintained by Alan Hamlett and
+Rana is written and maintained by Luna and
 various contributors:
 
 
-Development Lead
+This Fork's Development Lead
 ----------------
 
+- Luna <luna@l4.pm>
+
+Upstream Development Lead
+-------------------------
+
 - Alan Hamlett <alan.hamlett@gmail.com>
 
-
-Patches and Suggestions
+Upstream Patches and Suggestions
 -----------------------
 
 - 3onyc <3onyc@x3tech.com>
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..61652f9
--- /dev/null
+++ b/README.md
@@ -0,0 +1,112 @@
+rana-cli
+=========
+
+Command line interface to [rana](https://github.com/lnyaa/rana).
+
+This is a fork of the wakatime CLI tool for use with rana.
+
+**Rana is not affiliated with WakaTime.**
+
+Go to http://gitdab.com/lavatech to install the plugin for your text editor or IDE.
+
+## Installation / Forking WakaTime plugins
+
+Note: You shouldn't need to directly use this package unless you're building
+your own plugin *or* forking an existing WakaTime plugin for support with Rana.
+
+Since plugins install the WakaTime CLI directly, the recommendation for plugin
+forkers is to copy this repository into the plugin's installation of WakaTime CLI.
+
+*Keep in mind to remove the copied .git directory if it was copied.* WakaTime
+plugins don't use git submodules and instead use a full copy of the CLI source.
+
+WakaTime plugins can be found in https://wakatime.com/editors.
+
+WakaTime plugins *with Rana support* can be found in https://gitdab.com/lavatech.
+
+## Usage
+
+rana-cli aims to be a seamless replacement of WakaTime CLI. As such, all existing
+documentation of WakaTime CLI applies to rana-cli.
+
+ - https://wakatime.com/help/misc/creating-plugin
+ - https://wakatime.com/faq
+
+## Configuration
+
+rana-cli, as of right now, has a single extra field in the configuration file:
+`api_key`, so that you can switch easily between rana instances (e.g prod/local)
+
+The config file is found on `$WAKATIME_HOME/.wakatime.cfg`, which is the user's
+current home directory for UNIXes.
+
+An example config file is as follows. 
+
+```
+[settings]
+debug = false
+api_key = your-api-key
+base_url = https://your-rana-instance.com
+hide_file_names = false
+hide_project_names = false
+exclude =
+    ^COMMIT_EDITMSG$
+    ^TAG_EDITMSG$
+    ^/var/(?!www/).*
+    ^/etc/
+include =
+    .*
+include_only_with_project_file = false
+status_bar_icon = true
+status_bar_coding_activity = true
+offline = true
+proxy = https://user:pass@localhost:8080
+no_ssl_verify = false
+ssl_certs_file =
+timeout = 30
+hostname = machinename
+
+[projectmap]
+projects/foo = new project name
+^/home/user/projects/bar(\d+)/ = project{0}
+
+[git]
+disable_submodules = false
+```
+
+The default config file may be:
+
+```
+[settings]
+debug = false
+hidefilenames = false
+ignore =
+    COMMIT_EDITMSG$
+    PULLREQ_EDITMSG$
+    MERGE_MSG$
+    TAG_EDITMSG$
+
+base_url=https://rana.lavatech.top
+api_key=awoo
+```
+
+Check https://wakatime.com/faq for other config options.
+
+## Running tests
+
+Install dev requirements:
+```
+virtualenv venv
+venv/bin/pip install -r dev-requirements.txt
+venv/bin/pip install tox
+```
+
+Run tests:
+```
+tox
+```
+
+## Credits
+
+Thank you to the WakaTime developers and contributors for writing the CLI tool.
+