Skip to content

Commit e5b552a

Browse files
committed
Tidy up readme install instructions
1 parent 4a33ffa commit e5b552a

1 file changed

Lines changed: 7 additions & 18 deletions

File tree

README.md

Lines changed: 7 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ configuration, this can be blank if you wish to rely on the defaults for now.
2626
echo "{}" > .nfnl.fnl
2727
```
2828

29-
The first time you open a Fennel file under this directory you'll be prompted to
29+
The first time you write a Fennel file under this directory you'll be prompted to
3030
trust this configuration file since it's Fennel code that's executed on your
3131
behalf. You can put any Fennel code you want in this file, just be sure to
3232
return a table of configuration at the end.
@@ -171,18 +171,13 @@ modules or macros.
171171

172172
## Installation
173173

174-
- [Lazy][lazy]: `{ "Olical/nfnl", ft = "fennel" }`
174+
- [Lazy][lazy]: `{ "Olical/nfnl" }`
175175
- [Plug][plug]: `Plug 'Olical/nfnl'`
176176
- [Packer][packer]: `use "Olical/nfnl"`
177177

178-
[Lazy][lazy] will lazily load the plugin when you enter a Fennel file for the
179-
first time. There is no need to call `require("nfnl").setup()` right now, it's
180-
currently a noop but it may be used eventually. Some plugin managers support
181-
this function and will call it automatically.
182-
183-
- Requires Neovim > v0.9.0.
184-
- Add the dependency to your plugin manager.
185-
- Add lazy loading rules on the Fennel filetype if you want.
178+
Requires Neovim >= v0.9.0. nfnl uses `ftplugin` to activate when you open a
179+
Fennel file, so there is no need to call `require("nfnl")` or add lazy loading
180+
rules. Just install it and it works.
186181

187182
## Standard library
188183

@@ -408,16 +403,10 @@ which you can read about under the next header.
408403

409404
### Options
410405

411-
nfnl's user experience can be configured by `g:nfnl#...` prefixed global variables which can also be set by `.setup()` like so:
412-
413-
```lua
414-
require("nfnl").setup({ compile_on_write = false })
415-
```
416-
417-
These options customise general behaviour of the plugin that aren't limited to a specific directory or project.
406+
nfnl can be configured with `g:nfnl#...` global variables.
418407

419408
- `g:nfnl#compile_on_write`
420-
Set to `false` to disable the automatic compilation on buffer write. You will then need to use the `:NfnlCompile*` commands to compile your Fennel into Lua.
409+
Set to `false` to disable automatic compilation on buffer write. You will then need to use the `:NfnlCompile*` commands to compile your Fennel into Lua.
421410

422411
### API
423412

0 commit comments

Comments
 (0)