Skip to content

Commit

Permalink
create README and LICENSE
Browse files Browse the repository at this point in the history
  • Loading branch information
ik11235 committed Dec 24, 2022
1 parent f831971 commit 7ae48df
Show file tree
Hide file tree
Showing 3 changed files with 56 additions and 0 deletions.
7 changes: 7 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -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.
42 changes: 42 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -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)
7 changes: 7 additions & 0 deletions functions/wakatime.fish
Original file line number Diff line number Diff line change
@@ -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"
Expand Down

0 comments on commit 7ae48df

Please sign in to comment.