Update README

This commit is contained in:
Arkadiusz Wieczorek 2022-07-09 12:43:39 +02:00
parent d5fc4da1a1
commit c86a3e2c23

View File

@ -1,13 +1,18 @@
<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>
## Opis / 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 ~~steals~~ 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. Use latest node 16.x and npm 8.x
2. `npm install`
3. `npm run build`
4. The build code is located in the `lib/` directory
<div style="display: flex; align-items: flex-start; flex-flow: row;">
<img src="./assets/screenshots/1a.png" width="481" height="591.5" />
<img src="./assets/screenshots/1b.png" width="466.99" height="591.5"/>
@ -20,10 +25,3 @@ Note: At the moment, we support Polish language because this extension generates
<img src="./assets/screenshots/4b.png" />
<img src="./assets/screenshots/5a.png" />
<img src="./assets/screenshots/5b.png" />
## How build and run add-on
1. Use latest node 16.x and npm 8.x
2. `npm install`
3. `npm run build`
4. The build code is located in the `lib/` directory