1

Update README

This commit is contained in:
Alex Yatskov 2023-02-20 18:14:01 -08:00
parent 6c2a9d9cc0
commit 15336a718e

View File

@ -25,11 +25,11 @@ require('revolver').setup({
For the following examples, imagine that you have the files `foo.cpp`, `foo.h`, and `foo.inl` in a directory and are For the following examples, imagine that you have the files `foo.cpp`, `foo.h`, and `foo.inl` in a directory and are
currently editing `foo.cpp`. currently editing `foo.cpp`.
* `Revolver` \ #### `Revolver`
Invoking the `Revolver` command will open `foo.h`. Subsequent invocation will cause `foo.h` and `foo.inl` to open Invoking the `Revolver` command will open `foo.h`. Subsequent invocation will cause `foo.h` and `foo.inl` to open before
before wrapping back around to `foo.cpp`. The order that files are opened in corresponds to the ordering of suffixes wrapping back around to `foo.cpp`. The order that files are opened in corresponds to the ordering of suffixes provided
provided to the `setup` function. to the `setup` function.
* `RevolverBack` \ #### `RevolverBack`
This command is similar to `Revolver` with the difference being that suffix rotation occurs backwards. The first This command is similar to `Revolver` with the difference being that suffix rotation occurs backwards. The first file to
file to be opened would be `foo.inl`, followed by `foo.h`, and finally `foo.cpp` again. be opened would be `foo.inl`, followed by `foo.h`, and finally `foo.cpp` again.