Sort options

.editorconfig

@@ -1,14 +1,14 @@
-# editorconfig.org
-root = true
-
-[*]
-charset = utf-8
-end_of_line = lf
-indent_size = 2
-indent_style = space
-max_line_length = 120
-insert_final_newline = true
-trim_trailing_whitespace = true
-
-[*.{diff,md,mdx}]
-trim_trailing_whitespace = false
+# editorconfig.org
+root = true
+
+[*]
+charset = utf-8
+end_of_line = lf
+indent_size = 2
+indent_style = space
+max_line_length = 120
+insert_final_newline = true
+trim_trailing_whitespace = true
+
+[*.{diff,md,mdx}]
+trim_trailing_whitespace = false

.eslintignore

@@ -1,2 +1,3 @@
 npm node_modules
-build
+build
+main.js

README.md

@@ -32,6 +32,60 @@ Waypoint is an Obsidian plugin that automatically generates tables of contents/M
 
 Note that since waypoints can only be generated in folder notes, **it is highly recommended that you install a plugin like [Folder Note](https://github.com/xpgo/obsidian-folder-note-plugin)** to ensure that folder notes don't get lost after folder renames and other actions that change the file tree. If a folder note containing a waypoint is renamed to something other than the folder's name, the waypoint will no longer be updated.
 
+### Ordering Notes on Waypoint
+
+Waypoint provides the following methods for sorting your Notes:
+
+- Natural
+- Lexicographic
+- Priority
+- Folders First
+
+#### Natural Sort Order
+
+This is the default setting. Filenames are sorted alphabetically, except numeric portions are sorted in numerical order.
+
+```text
+- Note
+- Note1
+- Note2
+- Note100
+```
+
+#### Lexicograhic Order
+
+Filenames are sorted entirely alphabetically.
+
+```text
+- Note
+- Note1
+- Note100
+- Note2
+```
+
+#### Folders First
+
+- All folders appear at the top of the list and are sorted in a natural sort order
+- Files appear after any folders and sorted in natural sort order
+
+#### Priority Sort Order
+
+By default, notes in Waypoint are sorted alphabetically. However, with priority sort enabled, you can organize your notes in a specific order by enabling setting their Waypoint priorities. To do this, you would add an entry in your [note metadata](https://help.obsidian.md/Editing+and+formatting/Metadata) with a numeric value, such as:
+
+```markdown
+---
+waypointPriority: 0
+---
+
+# My note
+```
+
+Waypoint will then sort the notes based on the numeric value assigned to `waypointPriority`. Smaller values correspond to higher priority, so a note with `waypointPriority: 0` will appear above a note with `waypointPriority: 1`. If two notes have the same priority, they will be sorted alphabetically.
+
+In case a note does not have a `waypointPriority` defined, it will fall back to the default alphabetical sorting strategy.
+
+The `waypointPriority` key can be customized to a different key label in the Waypoint settings. This functionality works for both regular notes and folder notes.
+
 ## Current Limitations
 
 - **Waypoints can only be created within a folder note**