First commit

CONTRIBUTING.md

@@ -0,0 +1,17 @@
+# Contributing
+
+Contributions are very welcome in this project.
+
+When contributing to this repository, .
+
+Things to consider:
+- Please first discuss the change you wish to make via an [issue](https://github.com/jaime-olivares/yuml/issues), before proposing a change
+- Do not cover two different topics in a single pull request
+- Do not change or add libraries or tools (either for development or production purposes) without previous consent
+- Do not change symbol names (methods, properties), even if you think they are correct or better
+- Leave the code clean and **be sure you are not altering the spacing of the source code files**
+
+Standard steps:
+- Fork this project in github and clone it in your local machine
+- Debug in Visual Studio Code, reviewing all the affected functionalities
+- Commit and submit a [pull request](https://github.com/jaime-olivares/yuml/pulls)

LICENSE.md

@@ -0,0 +1,9 @@
+# The MIT License (MIT)
+
+Copyright (c) 2018 Jaime Olivares
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

README.md

@@ -0,0 +1,41 @@
+# yUML diagrammer
+Allows the creation of offline UML diagrams based on the [yUML Syntax](http://yuml.me/).
+
+## Features
+* Currently, the following diagram types are supported: 
+  + Class
+  + Activity 
+  + Use-case
+  + State
+  + Deployment
+  + Package
+  + Sequence
+* Additional directives for altering diagram type and orientation
+* Embedded rendering engine: **No need to call an external web service**
+
+## yUML syntax
+Please refer to the [wiki page](https://github.com/jaime-olivares/yuml/wiki)
+
+## Invocation methods
+
+````
+Code sample here
+````
+
+## Dependencies
+This npm package depends only on the [jsdom npm package](https://www.npmjs.com/package/jsdom), which is cross-platform and is installed automatically.
+
+Also, it contains a frozen version of viz-lite.js (see [viz.js](https://github.com/mdaines/viz.js)). Newest versions have a bug that caused [issue #23](https://github.com/jaime-olivares/vscode-yuml/issues/23).
+No other product or library is needed and thus the installation process is quite simple across platforms.
+
+## Issue reporting
+If you have experience developing Visual Studio Code extensions, please propose a detailed solution for any reported issue or feature request.
+
+## Contributing
+For pull requests, please read [CONTRIBUTING.md](https://github.com/jaime-olivares/yuml/blob/master/CONTRIBUTING.md)
+
+## Credits
+* Syntax and some examples taken from [yuml.me](http://yuml.me/diagram/scruffy/class/samples)
+* This package uses a Javascript port of [Dot/Graphviz](http://www.graphviz.org/) called [viz.js](https://github.com/mdaines/viz.js)
+* The yuml-to-dot translator is loosely based on a Python project called [scruffy](https://github.com/aivarsk/scruffy)
+* The new sequence diagram is based on [this github fork](https://github.com/sharvil/node-sequence-diagram)