add some links in readme

This commit is contained in:
Maximilian Keßler 2022-09-17 11:08:22 +02:00
parent 34c65b0aec
commit 126cf48b59
Signed by: max
GPG key ID: BCC5A619923C0BA5

View file

@ -1,6 +1,6 @@
# OnlineTichu Counter # OnlineTichu Counter
This is a [greasemonkey](https://github.com/greasemonkey/greasemonkey) userscript for onlinetichu.com to count cards. This is a [greasemonkey](https://github.com/greasemonkey/greasemonkey) userscript for [onlinetichu.com](onlinetichu.com) to count cards.
## Features ## Features
- Keeps track all cards played: - Keeps track all cards played:
@ -16,23 +16,23 @@ Possibly more in the future
## Usage ## Usage
- qutebrowser: just copy this userscript into the `greasemonkey` monkey folder in your qute config directory - qutebrowser: just copy this userscript into the `greasemonkey` monkey folder in your qute config directory
Usually, this is `.config/qutebrowser/greasemonkey`. Usually, this is `.config/qutebrowser/greasemonkey`.
- Firefox: Install the greasemonkey add-on. - Firefox: Install the [greasemonkey](https://addons.mozilla.org/en-US/firefox/addon/greasemonkey/) add-on.
Now you have to visit a website where this script is hosted with a `.user.js` extension. Now you have to visit a website where this script is hosted with a `.user.js` extension.
Unfortunately, I found no better way of installing user scripts to greasemonkey Unfortunately, I found no better way of installing user scripts to greasemonkey
The latest (or at least a) release (read: version that is not obviously broken) is available at The latest (or at least a) release (read: version that is not obviously broken) is available at
https://maximilian-kessler.de/files/greasemonkey/onlinetichu-counter.user.js https://maximilian-kessler.de/files/greasemonkey/onlinetichu-counter.user.js
On visiting onlinetichu.com, you should now automatically have the corresponding buttons and functionality On visiting [onlinetichu.com](onlinetichu.com), you should now automatically have the corresponding buttons and functionality
available in the upper status bar. available in the upper status bar.
## License ## License
This is MIT licensed. This is MIT licensed.
While the user script does hook into the javascript from onlinetichu.com, While the user script does hook into the javascript from [onlinetichu.com](onlinetichu.com),
it does not contain any such code which might or might not be free software. it does not contain any such code which might or might not be free software.
As this only _adds_ to what is there, I do not replicate other peoples work, As this only _adds_ to what is there, I do not replicate other peoples work,
although this of course builds on top of it. although this of course builds on top of it.
In particular, I can only license what I have written, not the javascript framework that In particular, I can only license what I have written, not the javascript framework that
onlinetichu.com itself implemented. [onlinetichu.com](onlinetichu.com) itself implemented.
## FAQ ## FAQ