README.md in plantuml_builder-0.1.1 vs README.md in plantuml_builder-0.2.0
- old
+ new
@@ -38,11 +38,11 @@
@enduml
```
The diagram above will be rendered to:
-
+
PlantUML web service expects compression of such diagrams into
it's own format. The diagram above should be converted to
```
@@ -51,10 +51,33 @@
Using `plantuml_builder` you can fetch rendered diagrams from specified server.
Diagrams could be fetched as SVG, PNG, and TXT (ASCII-art) format.
+
+### Using as standalone app
+
+To build one diagram in SVG format from plantuml.com run:
+
+```bash
+$ plantuml_build png source_file.wsd destination_file.svg
+```
+
+If you need build whole directory, specify `-R` flag before source. To build it into PNG diagrams:
+
+```bash
+$ plantuml_build png -R src dest
+```
+
+If you want to use local server as endpoint, specify it with `--endpoint`:
+
+```bash
+$ plantuml_build txt source_file.wsd destination_file.txt --endpoint=http://localhost:8080
+```
+
+### Using as library
+
First, receive diagram text (from WSD or other file format).
```ruby
wsd = <<-WSD
@startuml
@@ -66,11 +89,11 @@
deactivate MyService
@enduml
WSD
```
-### SVG
+#### SVG
Fetch diagram as SVG:
```ruby
PlantumlBuilder::Formats::SVG.new(wsd).load
@@ -80,18 +103,18 @@
PlantUML renders SVG as single line of XML code. It is not comfortable because it is impossible
to store it in version control system. So, `plantuml_builder` fixes it.
Also, XML comment with description would be removed.
-### PNG
+#### PNG
Fetch diagram as PNG:
```ruby
PlantumlBuilder::Formats::PNG.new(wsd).load
=> # diagram in PNG
```
-### TXT (ASCII-art)
+#### TXT (ASCII-art)
```ruby
PlantumlBuilder::Formats::TXT.new(wsd).load
```
Result could be outputed as: