zoriya/auto-save.nvim
1
0
Fork 0
mirror of https://github.com/zoriya/auto-save.nvim.git synced 2025-12-06 06:36:11 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: add note about conventional commits to readme (#14)

Browse Source
This commit is contained in:
okuuva
2023-03-28 10:24:02 +03:00
committed by GitHub
parent a5e39553c5
commit 1fe7f6243f
1 changed files with 2 additions and 14 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
README.md
View File

@@ -15,8 +15,6 @@
<img alt="Repo Size" src="https://img.shields.io/github/repo-size/okuuva/auto-save.nvim?color=%23DDB6F2&label=SIZE&logo=codesandbox&style=for-the-badge&logoColor=D9E0EE&labelColor=302D41"/></a> <img alt="Repo Size" src="https://img.shields.io/github/repo-size/okuuva/auto-save.nvim?color=%23DDB6F2&label=SIZE&logo=codesandbox&style=for-the-badge&logoColor=D9E0EE&labelColor=302D41"/></a>
</p> </p>
&nbsp;
### 📋 Features ### 📋 Features
- automatically save your changes so the world doesn't collapse - automatically save your changes so the world doesn't collapse
@@ -28,14 +26,10 @@
- multiple callbacks - multiple callbacks
- automatically clean the message area - automatically clean the message area
&nbsp;
### 📚 Requirements ### 📚 Requirements
- Neovim >= 0.5.0 - Neovim >= 0.5.0
&nbsp;
### 📦 Installation ### 📦 Installation
Install the plugin with your favourite package manager: Install the plugin with your favourite package manager:
@@ -89,8 +83,6 @@ EOF
</details> </details>
&nbsp;
### ⚙️ Configuration ### ⚙️ Configuration
**auto-save** comes with the following defaults: **auto-save** comes with the following defaults:
@@ -156,23 +148,19 @@ or as part of the `lazy.nvim` plugin spec:
``` ```
&nbsp;
### 🪴 Usage ### 🪴 Usage
Besides running auto-save at startup (if you have `enabled = true` in your config), you may as well: Besides running auto-save at startup (if you have `enabled = true` in your config), you may as well:
- `ASToggle`: toggle auto-save - `ASToggle`: toggle auto-save
&nbsp;
### 🤝 Contributing ### 🤝 Contributing
- All pull requests are welcome. - All pull requests are welcome.
- If you encounter bugs please open an issue. - If you encounter bugs please open an issue.
- Please use [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) when commiting.
- See [@commitlint/config-conventional](https://github.com/conventional-changelog/commitlint/tree/master/@commitlint/config-conventional) for more details.
### 👋 Acknowledgements ### 👋 Acknowledgements
This plugin wouldn't exist without [Pocco81](https://github.com/Pocco81)'s work on the [original](https://github.com/Pocco81/auto-save.nvim). This plugin wouldn't exist without [Pocco81](https://github.com/Pocco81)'s work on the [original](https://github.com/Pocco81/auto-save.nvim).
&nbsp;