Skip to content

Commit 00b3e08

Browse files
committed
Fix README typos
1 parent 5cece2a commit 00b3e08

File tree

1 file changed

+16
-13
lines changed

1 file changed

+16
-13
lines changed

README.md

Lines changed: 16 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ git clone https://github.com/mboughaba/vim-lessmess.git
3939

4040
2. Using [Vundle](https://github.com/VundleVim/Vundle.vim)
4141

42-
First, declare the plugin in you `.vimrc`
42+
First, declare the plugin in your `.vimrc`
4343
```vim
4444
Plugin 'mboughaba/vim-lessmess'
4545
```
@@ -51,7 +51,7 @@ Then run plugin install command
5151

5252
3. Using [Plug](https://github.com/junegunn/vim-plug)
5353

54-
First, declare the plug in you `.vimrc`
54+
First, declare the plug in your `.vimrc`
5555
```vim
5656
Plug 'mboughaba/vim-lessmess'
5757
```
@@ -70,11 +70,11 @@ This is fully tested and blazing fast but if you don't mind white-spaces in your
7070

7171

7272
## Usage
73-
Out of the box, this plugin will clean trailing white-space, fix mixed-indent and remove empty lines at the end of a file when the file is saved.
73+
Out of the box, this plugin will clean trailing white-spaces, fix mixed-indents and remove empty lines at the end of a file when the file is being saved.
7474
In more technical details, there are two important functions `LessmessExecute` and `LessmessDisplayToggle`.
7575

7676

77-
### Automagically remove all annoying white-spaces :heavy_check_mark:
77+
### Automagically :dizzy: remove all annoying white-spaces :heavy_check_mark:
7878
White-spaces removal `onsave` is enabled by default. Just save the buffer and the file is clean.
7979

8080

@@ -83,18 +83,18 @@ First, to disable lessmess `onsave` make sure to include the configuration below
8383
```vim
8484
let g:enable_lessmess_onsave = 0
8585
```
86-
To remove (on demand) trailing white-spaces, fix mixed-indent and remove newlines at the end of file all at once, call the following command:
86+
To remove `ondemand` trailing white-spaces, fix mixed-indents and remove newlines at the end of file all at once, call the following command:
8787
```vim
8888
LessmessExecute
8989
```
9090

9191

9292
### Simple white-spaces highlighting
93-
I personally don't see a need of white-space highlighting, if I know they will be removed when I save. Nevertheless, to toggle highlighting of hidden characters, use command below.
93+
I personally don't see a need of white-space highlighting, as long as I am confident they will be removed when I save. Nevertheless, to toggle highlighting of hidden characters, use command below.
9494
```vim
9595
LessmessDisplayToggle
9696
```
97-
This is simply calling vim native toggle list, I highly believe that syntax highlighting for white-spaces is a bit overkill. So why not just use ViM built-in list.
97+
This is simply calling vim native toggle list, I highly believe that syntax highlighting for white-spaces is a bit overkill in many cases so why not just use something as simple as ViM built-in list.
9898

9999

100100
### Configuration
@@ -103,7 +103,7 @@ This is simply calling vim native toggle list, I highly believe that syntax high
103103
LessmessToggle
104104
```
105105

106-
2. Plugin can be disabled per buffer. An example would disabling white-spaces trimming for all `vader` test files
106+
2. Plugin can be disabled per buffer. An example would disabling white-space trimming for all `vader` test files
107107
```vim
108108
"
109109
" Lessmess disable by FileType
@@ -120,8 +120,8 @@ let g:disable_lessmess = 1
120120
```
121121

122122

123-
### Handy tool
124-
When **Lessmess is disabled**, white-spaces can be removed by calling `force` execute:
123+
### Handy tool :wrench:
124+
When **Lessmess is disabled**, white-spaces can be removed by calling `force` execute :hammer::
125125
```vim
126126
LessmessForceExecute
127127
```
@@ -134,8 +134,8 @@ LessmessStatus
134134
```
135135

136136

137-
# Advanced configuration
138-
1. Lessmess can be configured to request user's confirmation before removing white-space. To enable this feature following configuration need to be added to the user's `.vimrc`
137+
### Advanced configuration
138+
1. Lessmess can be configured to request user's confirmation before removing white-spaces. To enable this feature, following configuration need to be added to the user's `.vimrc`
139139
```vim
140140
let g:confirm_whitespace_removal = 1
141141
```
@@ -153,11 +153,14 @@ test/vader/run
153153

154154

155155
## Self promotion
156-
Why this one and not the other two or three trailing white-spaces removal plugins?
156+
Why this one and not the other two trailing white-spaces removal plugins :question:
157157
1. This is fully `autoloaded`, slowing down your ViM startup time was not an option
158158
2. This is designed with performance in mind. The plugin doesn't do live updates, it does the heavy lifting when ViM is idle.
159159
1. Making use of Vim jobs is in the pipe.
160160
3. Absolutely no configuration is required to get started. Everything follows the [KISS principle](https://en.wikipedia.org/wiki/KISS_principle)
161161
4. This plugin is fully unit tested using [Vader](https://github.com/junegunn/vader.vim)
162162
5. This running on [Travis CI](https://travis-ci.org/mboughaba/vim-lessmess)
163163
6. This is actively maintained
164+
7. More features can be added easily on top of the base we have so far
165+
166+
:wave: Hey :grey_exclamation: if you like the plugin and find it useful hit :star:

0 commit comments

Comments
 (0)