wimi/README.md

1.5 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

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

The share/wimi/xpi/ directory contains signed XPI files for Firefox users. After downloading an XPI file the extension can be added to the browser from about:addons.

Sources

Credit

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

License

BSD Zero Clause
See LICENSE