Mercurial > obsidian-remember-file-state

changeset 47:8e8019698f16

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Update README
author Ludovic Chabant <ludovic@chabant.com>
date Wed, 20 Sep 2023 23:31:06 -0700
parents fb40e8d5d4e3
children bdaa6e2c18d6
files README.md
diffstat 1 files changed, 7 insertions(+), 5 deletions(-) [+]
line wrap: on
line diff
--- a/README.md	Wed Sep 20 23:14:12 2023 -0700
+++ b/README.md	Wed Sep 20 23:31:06 2023 -0700
@@ -1,11 +1,13 @@
 # Remember File State
 
 This [Obsidian](https://obsidian.md) plugin remembers the editor state of files
-as you switch between them. It restores the cursor position and scrolling position.
-The plugin doesn't do any polling, and strives to only do work when
-opening and closing files in order to not slow down the editing experience.
+as you switch between them. It restores the cursor position and scrolling
+position. By default, it also remembers these states across sessions by saving
+the data to disk.
 
-Note that this plugin doesn't currently remember state across sessions.
+This plugin doesn't do any polling and doesn't register any timers. It strives
+to only do work when opening and closing files in order to not slow down the
+editing experience.
 
 
 ## Developer Quickstart
@@ -18,7 +20,7 @@
 3. Run the usual incantations, such as `npm install`.
 4. Run the build process in watch mode so that it compiles the TypeScript code
    and overwrites the test vault's plugin: `npm run dogfood
-   /path/to/vault/.obsidian/plugins/obsidian-remember-state`.
+   /path/to/vault/.obsidian/plugins/obsidian-remember-file-state`.
 5. When making changes, trigger the "_Reload App Without Saving_" command to
    reload Obsidian.
 6. Optionally, hit `Ctrl-Shift-I` to open the developer console and see the