mirror of
https://github.com/zoriya/auto-save.nvim.git
synced 2025-12-05 22:26:12 +00:00
docs: add note about conventional commits to readme (#14)
This commit is contained in:
16
README.md
16
README.md
@@ -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>
|
||||
</p>
|
||||
|
||||
|
||||
|
||||
### 📋 Features
|
||||
|
||||
- automatically save your changes so the world doesn't collapse
|
||||
@@ -28,14 +26,10 @@
|
||||
- multiple callbacks
|
||||
- automatically clean the message area
|
||||
|
||||
|
||||
|
||||
### 📚 Requirements
|
||||
|
||||
- Neovim >= 0.5.0
|
||||
|
||||
|
||||
|
||||
### 📦 Installation
|
||||
|
||||
Install the plugin with your favourite package manager:
|
||||
@@ -89,8 +83,6 @@ EOF
|
||||
|
||||
</details>
|
||||
|
||||
|
||||
|
||||
### ⚙️ Configuration
|
||||
|
||||
**auto-save** comes with the following defaults:
|
||||
@@ -156,23 +148,19 @@ or as part of the `lazy.nvim` plugin spec:
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
||||
### 🪴 Usage
|
||||
|
||||
Besides running auto-save at startup (if you have `enabled = true` in your config), you may as well:
|
||||
|
||||
- `ASToggle`: toggle auto-save
|
||||
|
||||
|
||||
|
||||
### 🤝 Contributing
|
||||
|
||||
- All pull requests are welcome.
|
||||
- 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
|
||||
|
||||
This plugin wouldn't exist without [Pocco81](https://github.com/Pocco81)'s work on the [original](https://github.com/Pocco81/auto-save.nvim).
|
||||
|
||||
|
||||
|
||||
Reference in New Issue
Block a user