Update README

This commit is contained in:
Arkadiusz Wieczorek 2022-01-29 21:27:27 +01:00
parent 9e372ca130
commit 8e68719d84
2 changed files with 8 additions and 1107 deletions

View File

@ -1,11 +1,19 @@
<h1 style="display: flex; align-items: center;"><img src="./assets/icon-addon-2048.png" alt="Rentgen logo" style="margin-right: 1rem;" width="48"/> Rentgen</h1>
## Description
<strong>Rentgen</strong> to wtyczka dla przeglądarek opartych o Firefoxa, która automatycznie wizualizuje, jakie dane zostały ~~wykradzione~~ wysłane do podmiotów trzecich przez odwiedzane strony.
<strong>Rentgen</strong> is an add-on prepared for Firefox based browsers. This extension will automatically visualize all the data that a given website sends to third parties.
Note: At the moment, we support Polish language because this extension generates mail content that is dedicated to Polish website owners. In further versions of this add-on, we will add other languages as well.
## How build and run add-on
1. `npm install`
2. `npm run build`
3. The build code is located in the `lib/` directory
![screenshot](./screenshot.png)
![screenshot](./screenshot2.png)
![screenshot](./screenshot3.png)

1107
package-lock.json generated

File diff suppressed because it is too large Load Diff