Update README.md - add usage section
commitcef3dd56d2505e18cb5a9af681ff519a6f8e55aa
authorDenis Redozubov <denis.redozubov@gmail.com>
dateTue 19 Nov 2019, 11:16 (7 years ago)
parent227c014
README.md+14
@@ -1,3 +1,17 @@
11# xsd-isogen
22
33Tool to generate xml-isogen descriptions from xsd files
4+
5+Usage
6+=====
7+
8+Use `xsd-isogen in.xsd Generator > out.hs` for queries.
9+
10+Use `xsd-isogen in.xsd Parser > out.hs` for responses.
11+
12+Use `xsd-isogen in.xsd Both > out.hs` for common definitions.
13+
14+Keep in mind that name clashes are possible and should be disambiguated
15+manually. If you have a good idea how to handle that, feel free to create an
16+issue and/or PR. Module name for all auto-generated files is set to `module
17+Dummy where`, so it should be updated appropriately as well.