docs: update readme (#13)

Author: LostInTheLogs

README.md

@@ -1,11 +1,10 @@
 # bigfile.nvim
 
-This plugin disables certain features if the opened file is big.
+This plugin automatically disables certain features if the opened file is big.
 File size and features to disable are configurable.
 
-Automatic features/integrations include: `LSP`, `treesitter`, `indent_blankline`, `illuminate.vim` `NoMatchParen`, `syntax off`, ... (full list at the end)
+Features/integrations include: `LSP`, `treesitter`, `indent_blankline`, `illuminate.vim` `NoMatchParen`, `syntax off`, ... (full list at the end)
 
-Integrations that may need manual configuration: `treesitter`.
 You can also add your own features.
 
 # Setup
@@ -21,8 +20,11 @@ use {
 
 The plugin ships with common default options. No further setup is required.
 
+## Customization
+
 ```lua
-local default_config = {
+-- default config
+require("bigfile").config {
   filesize = 2, -- size of the file in MiB, the plugin round file sizes to the closest MiB
   pattern = { "*" }, -- autocmd pattern
   features = { -- features to disable
@@ -38,18 +40,16 @@ local default_config = {
 }
 ```
 
-Full description of features is at the end of this file.
-
-## Customization
+Full description of the default features is at the end of this file.
 
 You can override the default configuration, or add your own custom features
 
 ```lua
--- all fields except `name` and `disable` can be nil
+-- all fields except `name` and `disable` are optional
 local mymatchparen = {
   name = "mymatchparen", -- name
   opts = {
-    defer = false, -- true if `disable` should be called on `BufReadPost` and not `BufReadPre`
+    defer = false, -- set to true if `disable` should be called on `BufReadPost` and not `BufReadPre`
   },
   disable = function() -- called to disable the feature
     vim.cmd "NoMatchParen"

lua/bigfile/features.lua

@@ -67,7 +67,6 @@ feature("indent_blankline", {
   end,
 })
 
----@diagnostic disable: assign-type-mismatch
 feature("vimopts", {
   disable = function()
     vim.opt_local.swapfile = false
@@ -96,10 +95,10 @@ feature("filetype", {
 ----@return feature
 function M.get_feature(raw_feature)
   local name
-  if type(raw_feature) == "table" then -- builtin feature
+  if type(raw_feature) == "table" then -- custom feature
     name = raw_feature.name
     feature(name, raw_feature)
-  else
+  else -- builtin feature
     name = raw_feature
   end
 

lua/bigfile/init.lua

@@ -106,7 +106,10 @@ function M.setup(overrides)
     callback = function(args)
       pre_bufread_callback(args.buf, config)
     end,
-    desc = string.format("Performance rule for handling files over %sMiB", config.filesize),
+    desc = string.format(
+      "[bigfile.nvim] Performance rule for handling files over %sMiB",
+      config.filesize
+    ),
   })
 
   if vim.tbl_contains(config.features, "treesitter") then