diff --git a/README.md b/README.md index 4d9f4c6..fb54cf4 100644 --- a/README.md +++ b/README.md @@ -6,6 +6,7 @@ A simple, easy-to-use Vim alignment plugin without too much ambition. Features: - Optimized for code editing +- Requires minimal keystrokes - Extensible alignment rules - Aligns text around either _all or n-th_ occurrence(s) of the delimiter - Ignores comment lines @@ -54,18 +55,18 @@ With the mapping, you can align selected lines with a few keystrokes. - `-` Around the last occurrences of delimiters (`-1`) - `-2` Around the second to last occurrences of delimiters - ... -1. Delimiter (``, `=`, `:`, `.`, `|`, `,`) +1. Delimiter key (a single keystroke; ``, `=`, `:`, `.`, `|`, `,`) Alignment rules for the following delimiters have been defined to meet the most needs. -| Delimiter | Description/Use cases | -| --------- | ---------------------------------------------------------- | -| `` | General alignment around spaces | -| `=` | Operators containing equals sign (=, ==, !=, +=, &&=, ...) | -| `:` | Suitable for formatting JSON or YAML | -| `.` | Multi-line method chaining | -| `,` | Multi-line method arguments | -| | | Table markdown | +| Delimiter key | Description/Use cases | +| ------------- | ---------------------------------------------------------- | +| `` | General alignment around spaces | +| `=` | Operators containing equals sign (=, ==, !=, +=, &&=, ...) | +| `:` | Suitable for formatting JSON or YAML | +| `.` | Multi-line method chaining | +| `,` | Multi-line method arguments | +| | | Table markdown | ### Example command sequences diff --git a/doc/easy_align.txt b/doc/easy_align.txt index df662a9..911f726 100644 --- a/doc/easy_align.txt +++ b/doc/easy_align.txt @@ -29,7 +29,7 @@ With this mapping, you can align selected lines with a few keystrokes. - Around the last occurrences of delimiters (`-1`) -2 Around the second to last occurrences of delimiters ... -4. Delimiter +4. Delimiter key (a single keystroke) General alignment around whitespaces = Operators containing equals sign (=, ==, !=, +=, &&=, ...) : Suitable for formatting JSON or YAML