Skip to content

Commit

Permalink
Update Readme
Browse files Browse the repository at this point in the history
  • Loading branch information
sekhat committed Aug 9, 2017
1 parent 7eedae7 commit 63820e5
Showing 1 changed file with 40 additions and 0 deletions.
40 changes: 40 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,3 +53,43 @@ Which should give you a diagram like so

![Picture of post editor with example](https://raw.githubusercontent.com/sekhat/discourse-yuml/master/docs/ExampleUsage.png)

You can now specify the type of diagram you wish to draw via the `type` argument

For example to start a yuml activity diagram you can do the following:

[yuml type=activity]
(start)->[a]
[a]->(end)
[/yuml]

The following types are supported:

* `class` - For class diagrams
* `activity` - For activity diagrams
* `usecase` - For use case diagrams

If no type is specified, then `class` is used by default

The different diagram styles for yuml.me can also be specified via the `style` argument

For example

[yuml style=plain]
[Class]->[AnotherClass]
[/yuml]

The supported styles are:

* `scruffy`
* `plain`
* `boring`

If none is specified then by default `scruffy` is used.

These options can also be combined:

[yuml type=class style=plain]
[Class]->[AnotherClass]
[/yuml]

Enjoy

0 comments on commit 63820e5

Please sign in to comment.