From 18826f89a85e92948334e2cacf4443602ff0b064 Mon Sep 17 00:00:00 2001 From: Matt Trzcinski Date: Wed, 28 Aug 2019 19:40:43 -0400 Subject: [PATCH] Clearer langauge --- README.md | 24 +++++++++++++++++------- 1 file changed, 17 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index bc70e7f..57c46af 100644 --- a/README.md +++ b/README.md @@ -15,19 +15,29 @@ A [PlantUML](http://plantuml.sourceforge.net/) major mode for Emacs. # Quick Guide -1. Install with +1. Install with `M-x package-install` +2. Enable mode for current buffer `M-x plantuml-mode` +3. Write some PlantUML: ``` - M-x package-install - plantuml-mode +@startuml +Alice -> Bob: Authentication Request +Bob --> Alice: Authentication Response + +Alice -> Bob: Another authentication Request +Alice <-- Bob: Another authentication Response +@enduml ``` -2. Preview diagrams with `C-c C-c` (`plantuml-preview`). +4. Preview diagrams with `C-c C-c` (`plantuml-preview`). **WARNING:** This may send information to -`"https://www.plantuml.com/plantuml"`! Check that `plantuml-jar-path` -is correct for your use case and that `plantuml-default-exec-mode` is -set to `jar` before previewing any sensitive material. See [Execution modes](# Execution modes) for more information. +`"https://www.plantuml.com/plantuml"`! + +Check that `plantuml-jar-path` is correct for your use case and that +`plantuml-default-exec-mode` is set to `jar` before previewing any +sensitive material. See [Execution modes](# Execution modes) for more +information. ```lisp (setq plantuml-jar-path "/path/to/your/copy/of/plantuml.jar")