From 28a8799d4718329f53385df19692bf06132a9070 Mon Sep 17 00:00:00 2001 From: faizanvahevaria Date: Thu, 24 Oct 2019 19:02:45 +0530 Subject: [PATCH] Updated README, package --- README.md | 33 ++++++++++++++++++++++++++++++++- package.json | 6 +++--- 2 files changed, 35 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 519509b..770c89c 100644 --- a/README.md +++ b/README.md @@ -1 +1,32 @@ -# staruml-model-interchange \ No newline at end of file +# Model Interchange for StarUML + +![Raw](https://rfc.unprotocols.org/spec:2/COSS/raw.svg) v0.1 + +This specification provides a standard JSON structure/schema for the representation of semantic library content and API models. This is used to import library content into any conformant modelling tool, and to interchange API models between conformant modelling tools. + +This specification will have achieved its purpose when at least two different modelling tools (UML based or otherwise) can successfully interchange any of the three model types. + +## Using the extension. + +Install the extension in the usual way for [StarUML extensions](https://docs.staruml.io/user-guide/managing-extensions#install-extension). Then select Tools->model interchange from your StarUML menu, select the UML package for export and click OK. That's it. + +## About this extension + +* Title : OpenAPI3.0 Generator +* description : Implementation of UML to model interchange in accordance with https://edi3.org/specs/edi3-model-interchange/master/. +* License : GPL3 +* Author : + * GoSource Pty Ltd + * info@gosource.com.au + * https://gosource.com.au + +## Support or contribution to this extension + +* Raise a ticket in this repo +* Make a pull request to this repo + +## Support on the underlying Model Interchange->API specification + +* join the [edi3.org slack](https://edi3.org/community/) +* raise a ticket in https://github.com/edi3/edi3-model-interchange + diff --git a/package.json b/package.json index 00259fa..a939541 100644 --- a/package.json +++ b/package.json @@ -1,8 +1,8 @@ { "name": "staruml-model-interchange", - "title": "staruml-model-interchange", - "description": "staruml-model-interchange repository", - "version": "0.1", + "title": "model-interchange", + "description": "This specification provides a standard JSON structure/schema for the representation of semantic library content and API models. This is used to import library content into any conformant modelling tool, and to interchange API models between conformant modelling tools.", + "version": "0.1.1", "engines": { "staruml": ">=3.0.0" },