Skip to content

Commit e8dca61

Browse files
committed
Modernize README
1 parent e49d6c2 commit e8dca61

File tree

1 file changed

+17
-23
lines changed

1 file changed

+17
-23
lines changed

README.markdown

Lines changed: 17 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
1-
surround.vim
2-
============
1+
# surround.vim
32

43
Surround.vim is all about "surroundings": parentheses, brackets, quotes,
54
XML tags, and more. The plugin provides mappings to easily delete,
@@ -61,37 +60,32 @@ and removing pairs of tags simultaneously is a breeze.
6160
The `.` command will work with `ds`, `cs`, and `yss` if you install
6261
[repeat.vim](https://github.com/tpope/vim-repeat).
6362

64-
Installation
65-
------------
63+
## Installation
6664

67-
If you don't have a preferred installation method, I recommend
68-
installing [pathogen.vim](https://github.com/tpope/vim-pathogen), and
69-
then simply copy and paste:
65+
Install using your favorite package manager, or use Vim's built-in package
66+
support:
7067

71-
cd ~/.vim/bundle
72-
git clone git://github.com/tpope/vim-surround.git
68+
mkdir -p ~/.vim/pack/tpope/start
69+
cd ~/.vim/pack/tpope/start
70+
git clone https://tpope.io/vim/surround.git
71+
vim -u NONE -c "helptags surround/doc" -c q
7372

74-
Once help tags have been generated, you can view the manual with
75-
`:help surround`.
76-
77-
Contributing
78-
------------
73+
## Contributing
7974

8075
See the contribution guidelines for
8176
[pathogen.vim](https://github.com/tpope/vim-pathogen#readme).
8277

83-
Self-Promotion
84-
--------------
78+
## Self-Promotion
8579

86-
Like surround.vim? Follow the repository on
80+
Like surround.vim? Star the repository on
8781
[GitHub](https://github.com/tpope/vim-surround) and vote for it on
88-
[vim.org](http://www.vim.org/scripts/script.php?script_id=1697). And if
89-
you're feeling especially charitable, follow [tpope](http://tpo.pe/) on
90-
[Twitter](http://twitter.com/tpope) and
91-
[GitHub](https://github.com/tpope).
82+
[vim.org](https://www.vim.org/scripts/script.php?script_id=1697).
83+
84+
Love surround.vim? Follow [tpope](http://tpo.pe/) on
85+
[GitHub](https://github.com/tpope) and
86+
[Twitter](http://twitter.com/tpope).
9287

93-
License
94-
-------
88+
## License
9589

9690
Copyright (c) Tim Pope. Distributed under the same terms as Vim itself.
9791
See `:help license`.

0 commit comments

Comments
 (0)