Adding README.md

README.md

@@ -0,0 +1,82 @@
+# UniTO book scrape
+_English version [below](#unito-book-scrape-english)._
+
+UniTO-book-scrape è un'applicazione pensata per semplificare l'uso della biblioteca virtuale dell'Università di Torino (UniTO). 📚
+
+L'applicazione è in grado di scaricare un libro, salvandolo in un comodo documento PDF. 📄
+
+## Vantaggi
+- Seleziona e cerca nel testo 🔎
+- Effettua il login una volta sola 🔓
+- Portabilità 🛩
+
+A differenza della biblioteca virtuale, i PDF generati da quest'app dispongono di testo selezionabile!
+
+Una volta effettuato il login e generato un PDF non sarà più necessario connettersi alla rete o inserire credenziali!
+
+
+## Esecuzione
+[Accedere](https://github.com/ornato-t/UniTO-book-scrape/releases) all'ultima versione dell'app utilizzando la barra sulla destra (Releases). Da lì sarà possibile scaricare un archivio compresso contenente un eseguibile (.exe).
+
+In alternativa, è possibile utilizzare NodeJS per eseguire gli script localmente.
+
+```bash
+npm i 
+```
+per installare le dipendenze
+```bash
+npm start
+```
+per compilare `index.ts` ed eseguire il risultante file `index.js`.
+
+È possibile compilare tale script in un file binario tramite
+```bash
+npm run build
+```
+
+## Disclaimer
+Lo sviluppatore non ha modo di controllare l'uso che viene fatto dei PDF generati; pertanto ogni responsabilità è a carico degli utenti.
+
+L'uso dell'app e dei PDF generati **DEVE** essere limitato a studenti regolarmente immatricolati presso UniTO e con diritto di accedere alla biblioteca virtuale.
+
+Ogni eventuale violazione di copyright è a carico degli utenti.
+
+# UniTO book scrape (English)
+
+UniTO-book-scrape is an application meant to simplify the use of the Università di Torino (UniTO) virtual library. 📚
+
+The application is able to download a book, saving it in a convenient PDF document. 📄
+
+## Advantages
+- Select and search through text 🔎
+- Log in only once 🔓
+- Documents are portable 🛩
+
+Unlike the virtual library, PDFs generated by this app feature selectable and searchable text!
+
+Once a PDF is generated, users won't have to connect to the Internet or log in to view it!
+
+## Execution
+[Access](https://github.com/ornato-t/UniTO-book-scrape/releases) to the latest version of the app by using the sidebar on the right (Releases). From there, download the zipped archive containing the executable file (.exe).
+
+Alternatively, users may also run the scripts locally via NodeJS.
+```bash
+npm i 
+```
+to install all dependencies
+```bash
+npm start
+```
+to compile `index.ts` and run the resulting `index.js` file.
+
+It is also possible to compile said file into a binary (.exe) via
+```bash
+npm run build
+```
+
+## Disclaimer
+The developer has no way of keeping track of how the generated PDF are used, therefore all responsibilities fall onto the users.
+
+The usage of the app and the generated PDFs **MUST** be limited to regularly enrolled UniTO students, with right to access the virtual library.
+
+Any and all copyright violations fall onto the user.

package.json

@@ -23,7 +23,8 @@
   },
   "devDependencies": {
     "esbuild": "0.17.11",
-    "nexe": "^4.0.0-rc.2"
+    "nexe": "^4.0.0-rc.2",
+    "typescript": "^4.9.5"
   },
   "type": "module"
 }