From 8d7b3a04ff0344ed1a130664cefd71d2145dc2d2 Mon Sep 17 00:00:00 2001 From: projectmoon Date: Tue, 3 Jan 2023 23:19:18 +0100 Subject: [PATCH] Update readme --- README.md | 25 +++++++++++++++++++++++-- 1 file changed, 23 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index f7e6e6d..fccc887 100644 --- a/README.md +++ b/README.md @@ -6,5 +6,26 @@ vanilla JavaScript, and a little bit of Bootstrap on top. ## Running -The application can be easily deployed to and run from a web server. -Simply clone the repository to a web server and serve the directory. +The application requires Yarn to build. Once it is installed, run +`yarn build` to build the bundle. Upload everything in the `dist/` +directory to a webserver and serve the directory as static files. + +## Technologies + +This small project is partly a playground for over-engineering. The +technologies used are: + + - **XSLT and XML:** Ancient, but still working in all browsers. + Easiest way to parse and view the backup files. + - **Typescript:** It's JavaScript, but better. + - **SASS**: It's CSS, but better. + - **Parcel:** Bundling tool with minimal configuration required to + build the web application. + - **Dexie (IndexedDB):** For saving previously-viewed backup files. + - **Bootstrap:** I am not good at making beautiful websites. + Bootstrap almost makes it look like I know what I'm doing. + +## License + +This software is open source softare, licensed under the AGPLv3. See +the `LICENSE` file for details.