Create README.md

Author: Idrinth

README.md

@@ -0,0 +1,26 @@
+# @idrinth/typescript-language-from-yaml
+
+This small project handles the conversion of transslation files from yaml to typescript. Install it and run the command `itlfy` to use it.
+
+## check
+
+The check command will check if the yaml files in your current working directory's `language` folder are valid and match. It  will error for unparseable files and keys not available in english, while  warning if keys are missing in other languages.
+
+`ilfy check` or `itlfy chheck root-folder-name`
+
+## generate
+
+Generate provides typescript language files according to your specification. It only works in your current  working directoy's `language` folder and will output to `ssrc/locales` by default.
+
+Options:
+
+- `--strict-types` apply strict types, so that typescript will error on build if the structures missmatch
+- `--verbatim-module-syntax` will export the type as a named export instead of a default one
+- `--split` splits  the language files at the top level keys.. Thhis leads to smaller files when using dynamic imports. Usually you want `--no-translations-file` as well in case of splitting.
+- `--no-translations-file` dissables the  creation of a translation object containing all languages
+
+## watch
+
+Watching will watch one or more language folders and rebuild  the typescript files whenever the yaml files change.If you don't give it a root folder, it will assume the current working directory.
+
+- `ilfy watch rootfolder1 rootfolder2`