diff --git a/README.md b/README.md index 4bd57c0..c82b598 100644 --- a/README.md +++ b/README.md @@ -12,7 +12,11 @@ For example, this tool can convert custom SUP or IGS files so they can be import - Only Scenarist MUI for graphic props are allowed (PGS, TextST, IGS…) but chances are other MUI assets (audio, video) can be converted too with some tweaks. ## Usage: -`python3 scenaristream.py PARAMETERS -o output_file` +If you would just like the client without thinking: +`python3 client.py PARAMETERS -o output_file`
+ +You can also install the small package and import the internal classes with `from scenaristream import EsMuiStream, StreamFile`.
+`EsMuiStream` parses a xES+MUI stream. `StreamFile` parses a raw stream like PG (SUP) or IG (MNU). ### Parameters `-s --stream ` – Input raw stream file (SUP-PGS or MNU-IGS).
@@ -27,5 +31,5 @@ The user is responsible for using the proper extension when converting to Scenar ### Example usage The command below converts a .SUP file to a PES+MUI Scenarist project.
-`python3 scenaristream.py -s subtitles.sup -o ./project/subtitles.pes`
+`python3 client.py -s subtitles.sup -o ./project/subtitles.pes`
In the project folder, subtitles.pes and subtitles.pes.mui will be created. \ No newline at end of file