Skip to content

Commit

Permalink
Deploy 3.0.0 from beta13
Browse files Browse the repository at this point in the history
  • Loading branch information
LunarWatcher committed Sep 10, 2021
1 parent 8e458c6 commit 0e758b0
Show file tree
Hide file tree
Showing 3 changed files with 23 additions and 6 deletions.
4 changes: 4 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
# 3.0.0

No changes; Purely a symbolic packaging for 3.0.0-beta13.

# 3.0.0-beta13
`let g:AutoPairsVersion = 30058`

Expand Down
23 changes: 18 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,18 +8,31 @@ Insert or delete brackets, parens, and quotes in pair: a maintained fork of [jia
There's several installation methods, and you're free to use whatever you want, but I personally cannot recommend [vim-plug](https://github.com/junegunn/vim-plug) enough, in part because of the previous line of text. Installation, if you expect a more or less working variant, should be done with:

```vim
Plug 'LunarWatcher/auto-pairs', { 'tag': '*' }
Plug 'LunarWatcher/auto-pairs'
```
(... = from Lunarwatcher/auto-pairs, pull the latest tag matching '*' -- a wildcard, which means the latest tag)

You can also use the latest commit, though tags are recommended:
You can also specify a tag, but this is no longer needed as of v3.0.0.

To use experimental changes before they're deployed, use:
```vim
Plug 'LunarWatcher/auto-pairs'
Plug 'LunarWatcher/auto-pairs', {'branch': 'develop'}
```

The develop branch contains improvements to the master branch. Note that this does not include the changes for 4.0.0; see the section below.

**Note:** I highly recommend using `let g:AutoPairsCompatibleMaps = 0` with this plugin. Setting it to 0 changes various mappings to use a control-based variant rather than a meta-based variant. This is to prevent issues with various alt combinations also being letters on the keyboard layout, as well as keeping things consistent if new maps are added (new maps will largely not use meta-based keybinds).

### 4.0.0 rewrite

v3.0.0 introduced a few years of feature requests and necessary bugfixes. Jumping into an existing system, there's a lot of suboptimal code and features that're blocked, largely due to technical debt. 4.0.0 aims to get rid of the tech debt, improve performance, and continue to improve features.

4.0.0 is currently a long-term project. Features will still be added to the master branch, currently on 3.x.x, until 4.0.0 is getting ready.

To use the 4.0.0 rewrite, use:
```vim
Plug 'LunarWatcher/auto-pairs', {'branch': 'develop-4.0.0'}
```


## Running tests (not required)

Auto-pairs comes with a few tests aimed at making sure nothing accidentally regresses without manually testing everything. Tests are in the test folder, and are in the vimspec format (using [themis.vim](https://github.com/thinca/vim-themis)); follow its instructions to run the tests.
Expand Down
2 changes: 1 addition & 1 deletion autoload/autopairs.vim
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ endif
" Current version; not representative of tags or real versions, but purely
" meant as a number associated with the version. Semantic meaning on the first
" digit will take place. See the documentation for more details.
let g:AutoPairsVersion = 30058
let g:AutoPairsVersion = 30059

let s:save_cpo = &cpoptions
set cpoptions&vim
Expand Down

0 comments on commit 0e758b0

Please sign in to comment.