Skip to content

fix README.md formatting for GitHub #6

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
GarthDB wants to merge 1 commit into
base: master
Choose a base branch
from
Open

fix README.md formatting for GitHub #6

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 12 additions & 12 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ GraphQL Extension for StarUML 3

[![Donate](https://img.shields.io/badge/Donate-PayPal-green.svg)](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=N7GUM99ZAU738)

This extension for StarUML(http://staruml.io) supports the generation of GraphQL IDL schemas from UML models.
This extension for StarUML(http://staruml.io) supports the generation of GraphQL IDL schemas from UML models.

What's new
----
Expand Down Expand Up @@ -44,13 +44,13 @@ Generation

**Disclaimer:** Neither StarUML nor this generator can enforce the limitations governed by the GraphQL expression language. It is of your responsibility to create data structures that will comply with the GraphQL specifications.

###GraphQL IDL Notation
### GraphQL IDL Notation

Let's start with the basics.

![](images/GraphqLCheatSheet.png)

###Classes, Default values & Directives
### Classes, Default values & Directives

So let's start with a basic class generation.
Here class attributes are given a type and a default value. We also made v3 a required field. Finally we added documentation here and there to demo what the generator does.
Expand Down Expand Up @@ -85,7 +85,7 @@ type DirectiveClass {
```


###Scalars & Enums
### Scalars & Enums

Scalars and Enumerations are supported by StarUML's native _Primitive_ and _Enumeration_ types. Please ensure you use these native StarUML types in order to generate the expected artifacts.

Expand All @@ -103,7 +103,7 @@ enum Enumeration1 {
```


###Union types
### Union types

Union types are defined by using _Dependencies_. Typically Unions do not carry any attributes or relations. The generator will warn when it encounters such structure.

Expand All @@ -128,7 +128,7 @@ union AnimalUnionType = Cat | Dog
# WARNING: Attributes on union types is not GraphQL compliant, ignoring.
```

###Associations, Aggregation & Composition
### Associations, Aggregation & Composition

Important facts, associations are:

Expand Down Expand Up @@ -196,7 +196,7 @@ type Component {
}
```

###Class and Interface hierarchies
### Class and Interface hierarchies

Unlike GraphQL syntax, there is no need to repeat the attribute definition across the hierarchy. The generator takes care of it, Neat!

Expand Down Expand Up @@ -311,7 +311,7 @@ interface I2 extends I1 {
```


###Schemas, Mutations
### Schemas, Mutations

![](images/schema_query_mutation_subscriptions__schema_and_more_7.png)

Expand Down Expand Up @@ -391,7 +391,7 @@ The following rules apply during generation.
* `name` property to field identifier.
* `type` property to field type, defaults to String.
* `multiplicity` property to array type and/or required constraint.
* GraphQL directives implemented via attribute's Tag(name, value)
* GraphQL directives implemented via attribute's Tag(name, value)
* GraphQL directives can also be modeled via an attribute Constraint(name, specification) - in which case they will not display in the diagram
* Default values generation.
* Documentation property to GraphQL comment.
Expand All @@ -405,7 +405,7 @@ The following rules apply during generation.
* _UMLParameter_'s type property to type of parameter.
* _UMLParameter_'s `multiplicity` property to array type and/or required constraint.
* _UMLParameter_ with `direction` = `return` to return type of method.
* GraphQL directives implemented via attribute's Tag(name, value)
* GraphQL directives implemented via attribute's Tag(name, value)
* GraphQL directives can also be modeled via an attribute Constraint(name, specification) - in which case they will not display in the diagram
* Documentation property to GraphQL comment.

Expand Down Expand Up @@ -495,7 +495,7 @@ About the Author

My name is [Olivier Refalo](https://www.linkedin.com/in/orefalo/), author behind this StarUML extension. I am an Innovator, a Digital transformer, a skilled Architect, a Leader and an Entrepreneur.

Over the years I grew extensive knowledge around data modeling, reactive technologies, business processes, integrations and enterprise architecture.
Over the years I grew extensive knowledge around data modeling, reactive technologies, business processes, integrations and enterprise architecture.
Lately I grew my technical skills around GraphQL which I see as an elegant way to solve the "middleware mess" with an inversion of control approach.

I believe in open source as a way to drive innovations and share knowledge, this project is yet another way to contribute back to the community. With that said, if you *do use* this project, please consider:
Expand All @@ -506,4 +506,4 @@ I believe in open source as a way to drive innovations and share knowledge, this

Thank you

Licensed under GPLv3
Licensed under GPLv3