diff --git a/README.md b/README.md index a6778b8..8b83937 100644 --- a/README.md +++ b/README.md @@ -4,19 +4,19 @@ muse is a Vim plugin for writing poetry and prose. It provides features such as AABB rhyme suggestions, synonym replacement, and syllable counting. It was -originally written under the name `rhymer` as a rhyming assistant and syllable +originally written under the name rhymer as a rhyming assistant and syllable counter for the UGAHacks 2018 hackathon. Usage instructions are included in the `doc/` directory, and are also available with `:help muse`. -## Installation +## Installation with vim-plug -1. Install [`vim-plug`](https://github.com/junegunn/vim-plug) +1. Install [vim-plug](https://github.com/junegunn/vim-plug) 2. Add `Plug 'gmarmstrong/vim-muse'` to the `plug` call in your `~/.vimrc` -3. Restart Vim -4. Enter `:PlugInstall` -5. Restart Vim +3. Restart Vim or enter `:source $MYVIMRC` +4. Enter `:PlugInstall vim-muse` +5. Restart Vim or enter `:source $MYVIMRC` 5. Enter `:MuseInstall` ## Updating