From bd29663248ce6e4ea80e6d03697c0f83786910d5 Mon Sep 17 00:00:00 2001
From: Ayaka <ayaka@kitty.community>
Date: Sun, 21 Apr 2024 22:20:12 +1200
Subject: [PATCH] Update README.md

---
 README.md | 193 +++++++++++++++++++++++++++++++++++++++++++++++++++++-
 1 file changed, 192 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 98acdf5..ff60e82 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,192 @@
-# MSE-Minecraft-Language
+
+# MSE-MC
+#### Maoist Standard English Minecraft language-pack generator
+---
+
+# Usage And Options
+
+ ```
+ ./packgen.js [OPTIONS]
+ ```
+
+ Example usage:
+
+* `./packgen.js --lang en_nz` generate a pack using `en_nz` insead of the default `en_gb`
+* `./packgen.js -f` generate a pack using with a descriptive output zip E.g. `en_gb-v1.19.1-en_MSE` insead of just `Maoist-Standard-English.zip`
+* `./packgen.js -m https://example.com/mc/game/version_manifest_v2.json -r https://resources.download.minecraft.net/` useing custom servers
+
+<details>
+<summary>* Valid language options</summary>
+
+```
+Recommended languages:
+(It is recommended to only use english languages
+ due to the nature of the translation)
+
+en_au
+en_ca
+en_gb
+en_nz
+en_pt
+en_ud
+enp
+enws
+
+All languages:
+
+af_za
+ar_sa
+ast_es
+az_az
+ba_ru
+bar
+be_by
+bg_bg
+br_fr
+brb
+bs_ba
+ca_es
+cs_cz
+cy_gb
+da_dk
+de_at
+de_ch
+de_de
+el_gr
+en_au
+en_ca
+en_gb
+en_nz
+en_pt
+en_ud
+enp
+enws
+eo_uy
+es_ar
+es_cl
+es_ec
+es_es
+es_mx
+es_uy
+es_ve
+esan
+et_ee
+eu_es
+fa_ir
+fi_fi
+fil_ph
+fo_fo
+fr_ca
+fr_fr
+fra_de
+fur_it
+fy_nl
+ga_ie
+gd_gb
+gl_es
+haw_us
+he_il
+hi_in
+hr_hr
+hu_hu
+hy_am
+id_id
+ig_ng
+io_en
+is_is
+isv
+it_it
+ja_jp
+jbo_en
+ka_ge
+kk_kz
+kn_in
+ko_kr
+ksh
+kw_gb
+la_la
+lb_lu
+li_li
+lmo
+lo_la
+lol_us
+lt_lt
+lv_lv
+lzh
+mk_mk
+mn_mn
+ms_my
+mt_mt
+nah
+nds_de
+nl_be
+nl_nl
+nn_no
+no_no
+oc_fr
+ovd
+pl_pl
+pt_br
+pt_pt
+qya_aa
+ro_ro
+rpr
+ru_ru
+ry_ua
+sah_sah
+se_no
+sk_sk
+sl_si
+so_so
+sq_al
+sr_cs
+sr_sp
+sv_se
+sxu
+szl\n
+ta_in
+th_th
+tl_ph
+tlh_aa
+tok
+tr_tr
+tt_ru
+uk_ua
+val_es
+vec_it
+vi_vn
+vp_vl
+yi_de
+yo_ng
+zh_cn
+zh_hk
+zh_tw
+zlm_arab
+```
+
+</details>
+
+## General Options:
+```
+Options:
+  -h, --help             Show help                                      [boolean]
+  -V, --version          Show version number                            [boolean]
+  -f, --descriptivefile  Descriptive output E.g. "en_gb-v1.19.1-en_MSE" [boolean]
+  -l, --lang             <language> base language for pack generation    [string]
+  -m, --manifest         <url> custom manifest endpoint                  [string]
+  -r, --resources        <url> custom resources endpoint                 [string]
+```
+
+# Why Us
+
+|                                     | Maoist  English | Our  Competitors |
+|-------------------------------------|:---------------:|:----------------:|
+| Indecipherable                      |        ✅        |         ❌        |
+| Upholds Marxist principles          |        ✅        |         ❌        |
+| Officially endorsed by George Soros |        ✅        |         ❌        |
+| Bourgeois app? bad vibes?           |        ❌        |         ✅        |
+
+
+## License
+
+[GNU GPLv3](https://choosealicense.com/licenses/gpl-3.0/)