Update README.md

README.md

@@ -1,2 +1,35 @@
 # jelly-snippets
 A simple text snippets plugin for Obsidian.md.
+
+
+## What does it do?
+
+Pretty simple. You probably have run into snippets before.
+
+1. Specify a mapping of snippet to replacement.
+	
+	`snippet. |+| replacement!`
+	
+2. If the cursor is at the end of a snippet...
+	
+	`snippet.<cursor here>`
+	
+3. ..then triggering the snippet conversion...
+	
+	`snippet.<cursor here - TRIGGER!>`
+	
+4. ..will replace the snippet with its replacement!
+	
+	`replacement!<cursor here>`
+	
+## Why?
+
+I wanted to make a generic snippets plugin that operated on text and worked as I needed. There is an existing snippets plugin already, [Text Snippets](https://github.com/ArianaKhit/text-snippets-obsidian) by ArianaKhit, but not only is the plugin code somewhat outdated and a little complex, it seems to use an older API.
+
+One of my goals writing this was to write a simple plugin that used the API exactly as described by the [unofficial docs](https://marcus.se.net/obsidian-plugin-docs/) and by vanilla Typescript. I also wanted to make the core functionality of the plugin more flexible, though of course I have yet to add certain features that would truly provide that.
+
+## Future Improvements
+
+- Control characters in snippets
+- Semantic symbols in snippets
+- Regex capabilities