Update README, bump version

README.md

@@ -2,38 +2,79 @@
 
 <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.
 
-## Funkcje Rentgena:
+**Funkcje Rentgena:**
 
-<ul>
+-   analiza ruchu sieciowego generowanego przez stronę internetową;
-    <li>
+-   wizualizacja danych przekazanych do podmiotów trzecich przez odwiedzaną stronę (historia przeglądania użytkownika oraz jego ciasteczka);
-        analiza ruchu sieciowego generowanego przez stronę internetową;
+-   przygotowywanie zrzutów ekranów narzędzi deweloperskich będących dowodem przekazanych danych do podmiotów trzecich;
-    </li>
+-   pomoc w oszacowaniu potencjalnych obszarów roboczych względem zgodności z RODO;
-    <li>
+-   generowanie raportu lub treści maila, którą można wysłać do administratora oraz Urzędu Ochrony Danych Osobowych.
-        wizualizacja danych przekazanych do podmiotów trzecich przez odwiedzaną stronę (historia przeglądania użytkownika oraz jego ciasteczka);
-    </li>
-    <li>
-        przygotowywanie zrzutów ekranów narzędzi deweloperskich będących dowodem przekazanych danych podmiotom trzecim;
-    </li>
-    <li>
-        pomoc w oszacowaniu potencjalnych obszarów roboczych względem zgodności z RODO;
-    </li>
-    <li>
-        generowanie raportu lub treści maila, którą można wysłać do administratora oraz Urzędu Ochrony Danych Osobowych.
-    </li>
-</ul>
 
-## English description
+## Jak zbudować i uruchomić Rentgena ze źródeł
 
-English: <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.
+### Wymagania wstępne
+
+-   System operacyjny: Linux x86_64
+-   Node.js: 16.x
+-   npm: 7.x lub wyższy
+
+### Proces budowy
+
+1. Pobierz repozytorium przez `git pull https://git.internet-czas-dzialac.pl/icd/rentgen.git` lub pobierz archwium zip
+2. Przejdź do
+3. Uruchom komendę: `npm install`
+4. Uruchom komendę: `npm run build`
+5. Uruchom komendę: `npm run create-package`
+6. Przejdź do katalogu `web-ext-artifacts`
+7. Znajdziesz tam archiwum zip: `rentgen-x-x-x.zip` (`x-x-x` oznaczają wersję wtyczki)
+
+### Kroki do uruchomienia
+
+1. Uruchom Firefoxa i przejdź do strony `about:debugging`
+2. Kliknij zakładkę _This Firefox_
+3. Kliknij przycisk _Load Temporary Add-on..._
+4. Wybierz archiwum, które zbudowałeś w ostatnim kroku procesu budowy
+
+---
+
+## English description 🇬🇧
+
+<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 to build and run add-on
+**Features:**
 
-1. Prepare node 16.x+ and npm 7.x+
+-   analysis of web traffic generated by the visited website;
-2. `npm install`
+-   visualization of data transmitted to third parties by the visited site (user's browsing history and cookies);
-3. `npm run build`
+-   preparation of screenshots of development tools as evidence of data transmitted to third parties;
-4. The build code is located in the `lib/` directory
+-   assisting in the evaluation of potential work areas for compliance with GDPR;
+-   generating a report or email content that can be sent to an administrator and Personal Data Protection Office in Poland.
+
+## How to build and run Rentgen on your own
+
+### Pre-requirements
+
+-   OS: Linux x86_64
+-   Node.js: 16.x version
+-   npm: 7.x version or higher
+
+### Build steps
+
+1. Pull repository or download a zip package
+2. Go to the root directory of the pulled repository
+3. Run command: `npm install`
+4. Run command: `npm run build`
+5. Run command: `npm run create-package`
+6. Go to the `web-ext-artifacts` directory
+7. You will find zip archive: `rentgen-x-x-x.zip` (`x-x-x` means add-on version)
+
+### Run steps
+
+1. Run Firefox and go to `about:debugging`
+2. Click _This Firefox_ tab
+3. Click _Load Temporary Add-on..._ button
+4. Pick the zip archive from last step of build process.
 
 ## Screenshots
 

manifest.json

@@ -3,7 +3,7 @@
     "manifest_version": 2,
     "name": "Rentgen",
     "short_name": "Rentgen",
-    "version": "0.1.2",
+    "version": "0.1.3",
     "author": "Kuba Orlik, Arkadiusz Wieczorek (Internet. Czas działać!)",
     "homepage_url": "https://git.internet-czas-dzialac.pl/icd/rentgen",
     "background": {

package.json

@@ -1,13 +1,14 @@
 {
     "name": "rentgen",
-    "version": "0.1.2",
+    "version": "0.1.3",
-    "description": "Rentgen 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.",
+    "description": "Rentgen 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.",
     "main": "esbuild.config.js",
     "type": "module",
     "scripts": {
         "build": "node esbuild.config.js",
         "watch": "node esbuild.config.js --watch",
         "ext-test": "web-ext run",
+        "build-addon": "npm i && npm run build && npm run create-package",
         "create-package": "web-ext build --ignore-files '!**/node_modules' '!**/node_modules/**/react-dom' '!**/node_modules/**/react-dom/umd' '!**/node_modules/**/*/react-dom.production.min.js' '!**/node_modules/**/react' '!**/node_modules/**/react/umd' '!**/node_modules/**/*/react.production.min.js' '!**/node_modules/**/survey-react'  '!**/node_modules/**/survey-react/*.min.js' '!**/node_modules/**/survey-react/*.min.css' --overwrite-dest",
         "typecheck": "tsc --noEmit",
         "lint": "web-ext lint"