wimi/README.md

56 lines
1.4 KiB
Markdown
Raw Normal View History

2023-09-27 02:57:29 +02:00
## About
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
2024-03-28 21:38:00 +01:00
## Example
2023-09-27 02:57:29 +02:00
2024-03-28 21:33:00 +01:00
<p align="center">
<img src="https://raw.githubusercontent.com/0x1eef/wimi/main/share/wimi/wimi.png">
</p>
2023-09-27 02:57:29 +02:00
## Install
2024-04-26 06:07:30 +02:00
**Chrome**
* 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**
The [share/wimi/xpi/](share/wimi/xpi/) directory contains
2024-04-26 06:07:30 +02:00
signed XPI files for Firefox users. After downloading an XPI file
the extension can be added to the browser from `about:addons`.
2023-09-27 02:57:29 +02:00
## Sources
* [GitHub](https://github.com/0x1eef/wimi#readme)
* [GitLab](https://gitlab.com/0x1eef/wimi#about)
2023-09-27 02:57:29 +02:00
## License
2023-09-27 02:57:29 +02:00
2024-08-03 23:07:13 +02:00
[BSD Zero Clause](https://choosealicense.com/licenses/0bsd/)
2023-09-27 02:57:29 +02:00
<br>
2024-08-03 23:07:13 +02:00
See [LICENSE](./LICENSE)