From 7ae48df648b7c6303e046af8dc5f0bfd51133dcd Mon Sep 17 00:00:00 2001
From: ik-fib <ik11235@gmail.com>
Date: Sat, 24 Dec 2022 20:00:45 +0900
Subject: [PATCH] create README and LICENSE

---
 LICENSE                 |  7 +++++++
 README.md               | 42 +++++++++++++++++++++++++++++++++++++++++
 functions/wakatime.fish |  7 +++++++
 3 files changed, 56 insertions(+)
 create mode 100644 LICENSE
 create mode 100644 README.md

diff --git a/LICENSE b/LICENSE
new file mode 100644
index 0000000..6751ce9
--- /dev/null
+++ b/LICENSE
@@ -0,0 +1,7 @@
+Copyright 2022 ik-fib
+
+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.
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..8360e0e
--- /dev/null
+++ b/README.md
@@ -0,0 +1,42 @@
+# wakatime.fish
+
+[fish](https://fishshell.com/) plugin for [WakaTime](https://wakatime.com/)
+
+Unofficial script for wakatime tracking in the fish shell.
+
+## Differences from [officially linked scripts](https://wakatime.com/terminal#install-fish)
+
+- Also works with wakatime-cli.
+- Use git information to determine project name.
+- Can be installed as a [fisher](https://github.com/jorgebucaran/fisher) plugin.
+
+
+## Getting Started
+
+### Prerequisites
+
+- [wakatime-cli](https://github.com/wakatime/wakatime-cli)
+- [fisher](https://github.com/jorgebucaran/fisher)
+
+#### wakatime-cli Install
+
+If it does not work, please refer to the [official documentation](https://wakatime.com/terminal).
+
+```bash
+pip install wakatime
+
+# or
+
+curl https://raw.githubusercontent.com/wakatime/vim-wakatime/master/scripts/install_cli.py | python3 -
+```
+
+
+### Installation
+
+```fish
+fisher install ik11235/wakatime.fish
+```
+
+## Licence
+
+[MIT](LICENSE)
\ No newline at end of file
diff --git a/functions/wakatime.fish b/functions/wakatime.fish
index 9e61df2..83da2fa 100644
--- a/functions/wakatime.fish
+++ b/functions/wakatime.fish
@@ -1,3 +1,10 @@
+###
+# wakatime.fish
+#
+#　hook script to send wakatime a tick (unofficial)
+# see: https://github.com/ik11235/wakatime.fish
+###
+
 function register_wakatime_fish_before_exec -e fish_preexec
   set -l PLUGIN_NAME "ik11235/wakatime.fish"
   set -l PLUGIN_VERSION "0.0.1"