Skip to content

Commit

Permalink
Update README.md - Add alternatives section
Browse files Browse the repository at this point in the history
  • Loading branch information
NMAC427 committed May 15, 2022
1 parent 7c1ac2c commit 3c17b9a
Showing 1 changed file with 12 additions and 4 deletions.
16 changes: 12 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ lines and uses them to determine how the buffer should be indented.
It then automatically updates the buffer options so that they match the
opened file.

# Installation
## Installation

Install using your favorite package manager and then call the following setup
function somewhere in your config:
Expand All @@ -38,12 +38,12 @@ use {
}
```

# Usage
## Usage

By default, guess-indent automatically runs whenever you open a new buffer.
You can also run it manually using the `:GuessIndent` command.

# Configuration
## Configuration

The plugin provides the following configuration options:

Expand All @@ -68,7 +68,15 @@ Normally it should not be necessary to disable the automatic execution of
guess-indent, because it usually takes less than a millisecond to run,
even for large files.

# Licence
## Alternatives

- [`indent-o-matic`](https://github.com/Darazaki/indent-o-matic) - Blazingly
fast, written in lua, based on a very simple algorithm.
[Comparison](https://github.com/Darazaki/indent-o-matic/issues/12)
- [`vim-sleuth`](https://github.com/tpope/vim-sleuth) - Very smart but slower
heuristic, compatible with Vim.

## Licence

This project is licensed under the terms of the MIT license.
For more detail check out the [LICENSE](./LICENSE) file.

0 comments on commit 3c17b9a

Please sign in to comment.