From 8df684bcb3c5fff8fa9a772952763fc3f6eb75ad Mon Sep 17 00:00:00 2001 From: Pocco81 Date: Tue, 2 Nov 2021 19:21:31 -0500 Subject: [PATCH] doc: documented vim.g.autosave_state --- README.md | 19 +++++++++++++------ 1 file changed, 13 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 68352ca..3d9007f 100644 --- a/README.md +++ b/README.md @@ -60,9 +60,11 @@ * [For init.lua](#for-initlua) * [For init.vim](#for-initvim) * [Updating](#updating) -* [Usage (commands)](#-usage-commands) - * [Default](#default) - * [Extra](#extra) +* [Usage](#-usage) + * [Commands](#commands) + * [Default](#default) + * [Extra](#extra) + * [General](#general) * [Configuration](#-configuration) * [General](#general) * [Conditions](#conditions) @@ -206,16 +208,21 @@ This depends on your plugin manager. If, for example, you are using Packer.nvim, :PackerUpdate ``` -# 🤖 Usage (commands) +# 🤖 Usage + +## Commands All the commands follow the *camel casing* naming convention and have the `AS` prefix so that it's easy to remember that they are part of this plugin. These are all of them: -## Default +### Default + `:ASToggle`: toggles AutoSave.nvim on and off. -## Extra +### Extra + `:ASOn`: turns AutoSave.nvim on. + `:ASOff`: turns AutoSave.nvim off. +## General ++ `vim.g.autosave_state`: use this to check whether AutoSave is on (`true`) or off (`false`). + # 🐬 Configuration Although settings already have self-explanatory names, here is where you can find info about each one of them and their classifications!