diff doc/core.txt @ 1:7c5bd18befd2 default tip

Some basic usage
author Luka Sitas <lsitas@avatarasoftware.com>
date Tue, 10 Mar 2026 21:31:17 -0400
parents 7bb5f650cfb7
children
line wrap: on
line diff
--- a/doc/core.txt	Tue Mar 10 20:28:16 2026 -0400
+++ b/doc/core.txt	Tue Mar 10 21:31:17 2026 -0400
@@ -2,15 +2,20 @@
 
 INTRODUCTION                                        *core*
 
-core is a minimal example plugin.
+core is a minimal plugin providing some consistent and 
+re-usable functionality.
 
 USAGE                                              *core-usage*
 
-    :CoreGreet
-        Echo a greeting message. You can customize it with
-        g:core_greeting:
+function core#PopupCommand({command})
+	Create a popup that runs a terminal {command}
 
-        >   let g:core_greeting = 'Hi there!'
+function core#ReadOnlyPopup(content)
+	Create a read only popup with the {contents}.
+	There is currently no easy way to close this buffer.
+
+function core#ExecuteCommand(command)
+	Executes {command} and returns the results.
 
 INSTALLATION                                       *core-install*