Improve readme with instructions for running the transformer

[sixdiamants]

Issue type:

• 🐛 Bug

---

Background:

The OSLO standards found their way into SEMIC. This raises the expectation that UML that conforms to the guidelines can be transformed into RDF according to the SEMIC guideline. People will want to apply the same UML-to-RDF mappings as to avoid divergence.

---

Description:

As a consequence I wish to run your transformer and check how my UML, built with Sparx EA, turns into RDF.

The doc states how to install the converter npm install @oslo-flanders/ea-converter; fine. Then I run into trouble, not being a web-developer. Here are some suggestions as to how you may want to complete the documentation

• prerequisites to running the transformer (node.js, ts-node ?)
• a complete CLI-command (it now only says The service is executed from the CLI...). Eg. > ts-node /path/to/repo/bin/runner.ts
• a list of EA file types that the transformer accepts, e.g. eax, eap, feap, xmi v2.4+, ...
• a sample UML file so that users can experiment
• explain how the converter integrates into the toolchain or how to run stand-alone

[bertvannuffelen]

@sixdiamants, @ddvlanck and I, @bertvannuffelen like to support you in in this.
Documentation building is on our roadmap, but to go quicker we like to meet you
Can you contact me on [email protected] and then we look for a moment together.