From dfbaa98af6ba3fb11e00d6163e43eb37e85d0fb5 Mon Sep 17 00:00:00 2001 From: perro Date: Wed, 25 Jan 2023 18:00:59 -0800 Subject: [PATCH] README fix --- README.md | 46 +++++++++++++++++----------------------------- 1 file changed, 17 insertions(+), 29 deletions(-) diff --git a/README.md b/README.md index d70ce79..02088d5 100644 --- a/README.md +++ b/README.md @@ -364,39 +364,27 @@ Mandatory. ## Command-Line Interface ``` -yasd [-q | -l] CMD +usage: yasd [-h] [-q] [-l] [-n NUM] {convert,check,sample,document,man} [file] -CMD (mandatory and only one at once): +YASD, Yet Another Schema Definition. YASD is a YAML format for human writable +XSDs (XML Schema Definition), humans declare what is indispensable, leaving +the machines to do the rest of the unreadable . -convert [-f xsd | json] FILE -check FILE -sample [-n INT] FILE -man -help +positional arguments: + {convert,check,sample,document,man} + action to perform + file file in YAML format -ARGS: +options: + -h, --help show this help message and exit + -q, --quiet enable quiet mode + -l, --log write log + -n NUM, --num NUM number of XML samples; 1 by default --q | --quiet No prints; doesn't apply for man and help. --l | --logs Writes logs. --f | --format Format type; could be 'xsd' or 'json'; 'xsd' by default. --n | --num Number of samples; 1 by default. -convert Converts YASD file to XSD or JSON format; XSD by default. -check Validates YASD file. -sample Writes XML samples according to schema. -man Prints README.md -help Prints this. -FILE YAML file; file extension doesn't matter. - -EXAMPLES: - -yasd convert schema.yasd -yasd --quiet --logs convert schema.yasd -yasd -ql -f json convert schema.yasd -yasd check schema.yaml -yasd sample schema.yasd -yasd sample -n 10 schema.yaml -yasd man -yasd help +(c) 2023 Perro Tuerto . Founded by Mexican Academy of +Language . Licensed under GPLv3 +. ``` [^1]: The following explanation is practically a copy-paste from "XSD - The