aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md17
1 files changed, 17 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..2df2182
--- /dev/null
+++ b/README.md
@@ -0,0 +1,17 @@
+# Translate
+
+This app translate the text between languages live. It is based on the libretranslate api
+
+## Installation
+
+This is a static website. Copy all the files to the webroot of your webserver.
+
+Note: This requires a [libretranslate](https://github.com/LibreTranslate/LibreTranslate) server. Change to you endpoint in line 5 of index.js
+
+## Execution
+
+To debug this, you can setup a simple localhost server for development and testing.
+
+```bash
+python -m http.server
+```