From a9126b35e438256e59cbd9e9d4df5fc2282cf27d Mon Sep 17 00:00:00 2001
From: Marc Coquand <marc@baemingo.com>
Date: Sat, 20 May 2023 17:35:28 -0500
Subject: Update readme

---
 README.md             | 16 +++++++++++-----
 doc/BufferBrowser.txt | 30 +++++++++++-------------------
 2 files changed, 22 insertions(+), 24 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 
 
diff --git a/doc/BufferBrowser.txt b/doc/BufferBrowser.txt
index d257ad0..dd4c305 100644
--- a/doc/BufferBrowser.txt
+++ b/doc/BufferBrowser.txt
@@ -8,33 +8,25 @@ You can easily map these to whatever you want. Here is an example `init.lua`:
   vim.api.nvim_set_keymap('n', '<leader>b[', require("buffer_browser").next(), {desc = "Next [B]uffer [[]"})
   vim.api.nvim_set_keymap('n', '<leader>b]', require("buffer_browser").prev(), {desc = "Previous [B]uffer []]"})
 
-INSTALLATION
 
-Install through any of your favorite plugin managers. 
-
-### [lazy](https://www.lazyvim.org). 
-Make sure to run the setup function. For example with lazy:
-
-  {
-    'https://git.sr.ht/~marcc/BufferBrowser',
-    setup = function()
-        require('buffer_browser').setup()
-    end
-  }
-  
-  
 CONFIGURATION 
 
-You can configure the filetype_filters by passing a table to the setup function. For example with default config:
+You can configure the `filetype_filters` by passing a table to the `setup`
+function. This is the default config:
 
   require('buffer-browser').setup({
-      -- '' + 'netrw' is used to filter out netrw.
       filetype_filters = {'gitcommit', 'TelescopePrompt'}
   })
 
 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 the following:
+
+  vim.g.netrw_fastbrowse =0
+
+This will remove the netrw buffer and wipe it from the browser history when
+you open a new file.
 
-- 
cgit v1.2.3