Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add "Bundled versions" section to the readme #236

Merged
merged 1 commit into from
Apr 13, 2024
Merged

Add "Bundled versions" section to the readme #236

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,16 @@
This is an [EditorConfig][] plugin for Vim. This plugin can be found on both
[GitHub][] and [Vim online][].

## Bundled versions

Depending on which version of Vim or Neovim you are using, you might not need to
install this plugin at all:

* Vim 9.0.1799 and above comes bundled with [a version of this plugin][].
* Neovim 0.9 and above comes with [its own Lua-based implementation][].

Both support the usual [properties][], including `max_line_length`.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this paragraph needed? I feel this one causes more confusion.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's there to assure people that the bundled implementations are not a "light" version that's missing any features. For me personally this was one of the main questions that were on my mind when deciding whether to use the bundled version or install this plugin. Therefore I think that it makes sense to have at least something like this sentence. But if you have any suggestions on how to rephrase it, go ahead! :)

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

OK, no worry! I'll make changes


## Installation

To install this plugin, you can use one of the following ways:
Expand Down Expand Up @@ -138,6 +148,8 @@ Feel free to submit bugs, feature requests, and other issues to the
[PreserveNoEOL]: http://www.vim.org/scripts/script.php?script_id=4550
[Tim Pope's fugitive]: https://github.com/tpope/vim-fugitive
[Vim online]: http://www.vim.org/scripts/script.php?script_id=3934
[a version of this plugin]: https://github.com/vim/vim/pull/12902
[its own Lua-based implementation]: https://github.com/neovim/neovim/commit/ab9a2c49253413dbbb31756a3eeddb354a663035
[Vundle]: https://github.com/gmarik/Vundle.vim
[archive]: https://github.com/editorconfig/editorconfig-vim/archive/master.zip
[contribution guidelines]: https://github.com/editorconfig/editorconfig/blob/master/CONTRIBUTING.md#submitting-an-issue
Expand Down