update README, TODOs, and CHANGELOG to reflect that the current plugin discovery mechanism should be improved, but should find every vim/neovim plugin available in nixpkgs

Author: b-src

CHANGELOG.md

@@ -5,8 +5,9 @@
 
 ### Docs
 
+- Update docs regarding plugin discovery limitations
 - Add note about plugin display names in the Lazy dashboard
-- Add section on alternative tools to the README
+- Add section on alternative tools
 
 
 ## [0.2.0] - 2023-12-26

README.md

@@ -170,7 +170,7 @@ To provide nix store paths to the rest of the plugins in your configuration, upd
 ```Lua
 {
   repo/my-cool-plugin.nvim,
-  dir = require("lazy-nix-helper").get_plugin_path("my-cool-plugin"),
+  dir = require("lazy-nix-helper").get_plugin_path("my-cool-plugin.nvim"),
   ...
 }
 ```
@@ -353,7 +353,7 @@ After moving your `init.lua` directly into your NixOS config and sourcing the re
 
 Lazy-Nix-Helper can't currently find plugins installed by Nix on non-NixOS platforms.
 
-Currently only plugins in the `vimplugin` or `lua5.1` package groups are found. That includes all the plugins that I use, but I think there are other package groups where neovim plugins can exist.
+Lazy-Nix-Helper's plugin discovery mechanism searches the current system's installed packages for packages prefixed with `vimplugin` or `lua5.1`. As of 2023-12-27 these are the only two prefixes used by the vimPlugin packageset in the unstable branch of nixpkgs. This works for now, but may break if a new prefix is added or existing prefixes are changed. It would be best to allow a list of plugin paths to be passed into the `setup()` function so that the nix store paths of neovim plugins could be provided declaratively by the NixOS config.
 
 ## Alternatives
 

TODO.md

@@ -4,8 +4,8 @@
 
 - [x] naive implementation of nix store plugin discovery
 - [ ] make plugin discovery work in a non-nixos environment with nix installed
-- [ ] more robust implementation of nix store plugin discovery
-- [ ] find plugins from all possible package groups, not just `vimplugin` and `lua5.1`
+- [ ] allow passing in a list of nix store paths so that plugin discovery is unnecessary
+- [x] find plugins from all possible package groups, not just `vimplugin` and `lua5.1` (turns out this is all the package groups)
 - [x] get nix store plugin path given a plugin name
 - [x] can plugin names be made friendlier in configuration without risking collisions?
         can we let the user supply "my-plugin" while also checking the store for