Readme examples (#11)

* adding usage gif.

* bump version.

* Trying to clarify usage in readme.

Author: chrisdl

README.md

@@ -11,7 +11,51 @@ Extension for nova.app that allows you to perform simple sorting on highlighted
 
 Currently you can sort in 4 different ways:
 
-  - Sort multiple lines based on a regular 0-9a-z sort.
-  - Sort one or more lines internally. For example a line containing `cba` will become `abc`.
+  - Sort multiple lines alphanumerically.
+  - Sort content of one or more lines. For example a line containing `cba` will become `abc`.
   - Sort multiple lines based on length (the number of characters including whitespace).
   - Sort multiple lines based on length but reversed.
+
+# Examples
+
+```js
+// 1. Sort inline
+cba120 --> 012abc
+
+// 2. Sort inline (multiline)
+cba
+210
+// Becomes
+abc
+012
+
+// 3. Sort lines
+f
+e
+d
+// Becomes
+d
+e
+f
+
+// 4. Sort lines based on length
+aaa
+aa
+a
+// Becomes
+a
+aa
+aaa
+
+// 5. Sort lines (length reversed)
+b
+bbb
+bb
+bbbb
+// Becomes
+bbbb
+bbb
+bb
+b
+```
+

Sort.novaextension/README.md

@@ -8,7 +8,51 @@ Extension for nova.app that allows you to perform simple sorting on highlighted
 
 Currently you can sort in 4 different ways:
 
-  - Sort multiple lines based on a regular 0-9a-z sort.
-  - Sort one or more lines internally. For example a line saying `cba` will say `abc`.
-  - Sort multiple lines based by length (the number of characters including whitespace).
+  - Sort multiple lines alphanumerically.
+  - Sort content of one or more lines. For example a line containing `cba` will become `abc`.
+  - Sort multiple lines based on length (the number of characters including whitespace).
   - Sort multiple lines based on length but reversed.
+
+# Examples
+
+```js
+// 1. Sort inline
+cba120 --> 012abc
+
+// 2. Sort inline (multiline)
+cba
+210
+// Becomes
+abc
+012
+
+// 3. Sort lines
+f
+e
+d
+// Becomes
+d
+e
+f
+
+// 4. Sort lines based on length
+aaa
+aa
+a
+// Becomes
+a
+aa
+aaa
+
+// 5. Sort lines (length reversed)
+b
+bbb
+bb
+bbbb
+// Becomes
+bbbb
+bbb
+bb
+b
+```
+

Sort.novaextension/extension.json

@@ -3,7 +3,7 @@
   "name": "Sort",
   "organization": "Chris DiLorenzo",
   "description": "Sort lines by content or length in the editor.",
-  "version": "1.3.4",
+  "version": "1.3.5",
   "categories": ["commands"],
   "repository": "https://github.com/chrisdl/nova-sort",
   "bugs": "https://github.com/chrisdl/nova-sort/issues",

package.json

@@ -1,6 +1,6 @@
 {
   "name": "nova-sort",
-  "version": "1.3.4",
+  "version": "1.3.5",
   "description": "A Nova.app extension for sorting selections",
   "main": "Sort.novaextension/Scripts/main.js",
   "repository": {