initial project structure and framing

README.md

@@ -1,3 +1,15 @@
-# EdpuzzleTranslate
+# Edpuzzle Translate
 
-This repo hosts the source code to the Edpuzzle translator website hosted at translate.apexfight.net. It includes not only the front end, but the backend code to the site.
+This repo hosts the source code to the Edpuzzle translator website hosted at [translate.apexfight.net](https://translate.apexfight.net/). It includes not only the front end, but also the backend code to the site.  
+
+ALL of the code, data, files, and whatever may happen to reside within this repository is licensed as per the AGPL V3.0, a copy of which is located in the [LICENSE](https://gitea.apexfight.net/apex/EdpuzzleTranslate/src/branch/main/LICENSE) file.
+
+
+## Usage 
+Go to [translate.apexfight.net](https://translate.apexfight.net/) and paste the link to an edpuzzle video in.
+
+## Hosting
+If you want to host this yourself you need the following requirements:
+- This project probably needs [nix](https://nixos.org/download/) to build and run, you could do it manually, but using nix is much easier.
+- In addition to nix, you need some sort of web server to run the frontend, i personally recommend [Nginx](https://nginx.org/en/index.html), but you can use pretty much whatever, as the frontend is written with angular, and therefore statically loaded.
+- You will also need to have an api key to a [LibreTranslate](https://libretranslate.com/) instance, OR have your [own instance](https://docs.libretranslate.com/guides/installation/) running.