wimi/README.md
0x1eef 29f120e7f8
Some checks failed
myip.wtf / build (push) Has been cancelled
myip.wtf / tests (push) Has been cancelled
Remove share/wimi/xpi/
There's an official build on mozilla's store instead
2024-09-29 21:54:06 -03:00

1.7 KiB


wimi

wimi relays information about your public IP address from clean.myip.wtf/json to your browser. The primary development and runtime dependencies are TypeScript, preact, and webpack. 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.

Install

Chromium|Chrome

  • Produce the build/ directory

      $ git clone https://github.com/0x1eef/wimi
      $ cd wimi
      $ npm i
      $ npm run build:production
    
  • Load the extension

    • Visit chrome://extensions
    • Check Developer mode (top right hand corner)
    • Click Load unpacked extension
    • Choose the build/production/ directory from the file dialog
    • Done

Firefox

wimi can be installed from mozilla's store. The add-on can also be built locally and side-loaded - similar to the process that was described for Chromium|Chrome users.

Sources

Credit

The extension includes icons that have been downloaded via my premium account on flaticon. Credit to the original graphic artists

License

The MIT License
See LICENSE