From fec1d4fb9d3b720f15931308b207cd8ad65f4f75 Mon Sep 17 00:00:00 2001 From: excalamus <53576362+excalamus@users.noreply.github.com> Date: Sat, 19 Oct 2019 10:50:00 -0400 Subject: [PATCH] Quick intro and warning to README (#112) * more robust matching of notes Signed-off-by: Michael Steiner * - allow for white-space and comments after all begin/end indent regexps - make end indent regexp symmetrical to being regexp allowing for selective change (e.g., disactivation via non-matching regexp) what is leads to indentation Signed-off-by: Michael Steiner * - give user some control to override in comments level of indentation Signed-off-by: Michael Steiner * Include configuration warning * Fiddle with the formatting * Clearer langauge * Try to fix internal link * Move important information to beginning of sentance * Ensure base64 encoding happens after coding the string with UTF8 (#111) * Fixes #110 Ensure base64 encoding happens after coding the string with UTF8 * Avoid line breaks in base64 encoding * Added run mode EXECUTABLE (#102) * Better version management * Avoid zero-padding of hours to mimic MELPA * Use `car` instead of `first` * Use UTC timezone when setting dates, to align with MELPA * Ignore java warnings * Fix tests * Bump version * Prepping for the new release * Bump version after release * Bumping java version for CI * Fix emacs 26 build * Aesthitics, just aesthetics * Trying to re-enable builds against Emacs master * Disabling master again * Ensure base64 encoding happens after coding the string with UTF8 (#111) * Fixes #110 Ensure base64 encoding happens after coding the string with UTF8 * Avoid line breaks in base64 encoding * Fix note syntax in tests * Prepping for v1.4.1 * Make mention of alternative exec modes * Include configuration warning * Fiddle with the formatting * Clearer langauge * Try to fix internal link * Move important information to beginning of sentance * Make mention of alternative exec modes --- README.md | 35 +++++++++++++++++++++++++++++++++++ 1 file changed, 35 insertions(+) diff --git a/README.md b/README.md index 29f6d2f..94085c8 100644 --- a/README.md +++ b/README.md @@ -12,6 +12,41 @@ A [PlantUML](http://plantuml.sourceforge.net/) major mode for Emacs. +# Quick Guide + +1. Install with `M-x package-install` +2. Enable mode for current buffer `M-x plantuml-mode` +3. Write some PlantUML: + +``` +@startuml +Alice -> Bob: Authentication Request +Bob --> Alice: Authentication Response + +Alice -> Bob: Another authentication Request +Alice <-- Bob: Another authentication Response +@enduml +``` + +4. Preview diagrams with `C-c C-c` (`plantuml-preview`). + +**WARNING:** This may send information to +`"https://www.plantuml.com/plantuml"`! Check that +`plantuml-default-exec-mode` is configured correctly for your use case +before previewing any sensitive material. + +```lisp + ;; Sample jar configuration + (setq plantuml-jar-path "/path/to/your/copy/of/plantuml.jar") + (setq plantuml-default-exec-mode 'jar) + + ;; Sample executable configuration + (setq plantuml-executable-path "/path/to/your/copy/of/plantuml.bin") + (setq plantuml-default-exec-mode 'executable) +``` + +See [Execution modes](#execution-modes) for more information. + # Installation Make sure you have [MELPA](http://melpa.org/) enabled in your ``emacs.d``. Then, you can just