aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorMarc Coquand <marc@baemingo.com>2023-05-20 17:35:28 -0500
committerMarc Coquand <marc@baemingo.com>2023-05-20 17:35:28 -0500
commita9126b35e438256e59cbd9e9d4df5fc2282cf27d (patch)
treecbb4eeada1cc61b6f2f1dc8820d7d7e33b5d8679 /README.md
parent9c49cd7adb8d0254ea1efca28c46524d3fa51ed6 (diff)
downloadBufferBrowser-a9126b35e438256e59cbd9e9d4df5fc2282cf27d.tar.gz
BufferBrowser-a9126b35e438256e59cbd9e9d4df5fc2282cf27d.tar.bz2
BufferBrowser-a9126b35e438256e59cbd9e9d4df5fc2282cf27d.zip
Update readme
Diffstat (limited to 'README.md')
-rw-r--r--README.md16
1 files changed, 11 insertions, 5 deletions
diff --git a/README.md b/README.md
index bc549b3..b673b32 100644
--- a/README.md
+++ b/README.md
@@ -36,7 +36,7 @@ Install through any of your favorite plugin managers.
### [lazy](https://www.lazyvim.org).
-Make sure to run the setup function. For example with lazy:
+Add the following line to your config
```lua
{
@@ -44,7 +44,7 @@ Make sure to run the setup function. For example with lazy:
}
```
-Then run
+Then run somewhere in your init.lua.
```lua
require('buffer_browser').setup()
@@ -64,9 +64,15 @@ require('buffer-browser').setup({
This can be used to filter out buffers you do not want in the history.
-To immediately close netrw after you have opened a file, I recommend setting
-` g:netrw_fastbrowse = 0`, this will remove the netrw buffer and wipe it from
-the browser history.
+#### Removing Netrw buffers
+
+By default, BufferBrowser will remember Netrw buffers. To immediately close
+netrw after you have opened a file, you can add to init.lua
+
+` g:netrw_fastbrowse =0`
+
+This will remove the netrw buffer and wipe it from the browser history when
+you open a new file.
## Credits