# HG changeset patch # User Ludovic Chabant # Date 1695277866 25200 # Node ID 8e8019698f1632c143d1280462428b86d3da981d # Parent fb40e8d5d4e36b7a85b31dcb45295f9691be7d4e Update README diff -r fb40e8d5d4e3 -r 8e8019698f16 README.md --- 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