wimi/README.md

61 lines
1.7 KiB
Markdown
Raw Normal View History

2024-09-01 22:14:01 +02:00
<p align="center">
<img src="src/images/icon128x128.png"></img>
<br>
<strong>wimi</strong>
</p>
2023-09-27 02:57:29 +02:00
wimi relays information about your public IP address
from
2024-04-02 03:02:47 +02:00
[clean.myip.wtf/json](https://clean.myip.wtf/json)
2024-09-01 14:29:24 +02:00
to your browser. The primary development and runtime
dependencies are
[TypeScript](https://www.typescriptlang.org/),
[preact](https://preactjs.com/),
and
[webpack](https://webpack.js.org/).
The extension can be built locally and installed as a
developer extension / addon on both Chromium and FireFox.
There are XPI files provided for FireFox users as well.
2023-09-27 02:57:29 +02:00
## Install
**Chromium|Chrome**
2024-04-26 06:07:30 +02:00
* Produce the `build/` directory
2023-09-27 02:57:29 +02:00
$ git clone https://github.com/0x1eef/wimi
$ cd wimi
2024-04-07 00:19:21 +02:00
$ npm i
$ npm run build:production
2024-04-26 06:07:30 +02:00
* Load the extension
2024-09-01 14:37:28 +02:00
* Visit `chrome://extensions`
* Check `Developer mode` (top right hand corner)
* Click `Load unpacked extension`
* Choose the `build/production/` directory from the file dialog
* Done
2023-09-27 02:57:29 +02:00
2024-04-26 06:07:30 +02:00
**Firefox**
wimi can be installed [from mozilla's store](https://addons.mozilla.org/en-US/firefox/addon/97c865f874d543128d35/).
The add-on can also be built locally and side-loaded - similar
to the process that was described for **Chromium|Chrome** users.
2024-04-26 06:07:30 +02:00
2023-09-27 02:57:29 +02:00
## Sources
* [GitHub](https://github.com/0x1eef/wimi#readme)
* [GitLab](https://gitlab.com/0x1eef/wimi#about)
2024-09-03 16:46:56 +02:00
* [brew.bsd.cafe/@0x1eef](https://brew.bsd.cafe/0x1eef/wimi)
2023-09-27 02:57:29 +02:00
2024-09-03 00:08:07 +02:00
## Credit
The extension includes icons that have been downloaded
via my premium account on [flaticon](https://www.flaticon.com).
Credit to the original graphic artists
## License
2023-09-27 02:57:29 +02:00
2024-09-03 16:46:56 +02:00
[The MIT License](https://choosealicense.com/licenses/MIT/)
2023-09-27 02:57:29 +02:00
<br>
2024-09-03 05:32:47 +02:00
See [LICENSE](./share/wimi/LICENSE)