aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMinteck <nekostarfan@gmail.com>2021-09-25 01:24:27 +0200
committerMinteck <nekostarfan@gmail.com>2021-09-25 01:24:27 +0200
commita3393a3cdd54c67cc7fd02ba4befc1f4d58c8a1c (patch)
tree984097f1b1472e54b7b656ec79fe03273f33dbeb
parent644ab7209203e66e53fffc9bf2a2d10e26a3639e (diff)
downloadmetranslator-api-a3393a3cdd54c67cc7fd02ba4befc1f4d58c8a1c.tar.gz
metranslator-api-a3393a3cdd54c67cc7fd02ba4befc1f4d58c8a1c.tar.bz2
metranslator-api-a3393a3cdd54c67cc7fd02ba4befc1f4d58c8a1c.zip
Update the readme
-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