aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md12
1 files changed, 11 insertions, 1 deletions
diff --git a/README.md b/README.md
index 5689f09..8d48589 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,13 @@
# metranslator-api
-A translation API that can translate English to Metroz and Metroz to English \ No newline at end of file
+A translation API that can translate English to Metroz and Metroz to English
+
+## Usage
+```plaintext
+node index.js <mode> <target language> <message>
+```
+
+* `<mode>`:
+ * `debug` to get debugging information and pretty-printed JSON
+ * `release` to get beautiful data with details
+ * `api` to get machine-readable data, as a JSON object \ No newline at end of file