Skip to content

Commit 8515cad

Browse files
committed
update README.md
1 parent 6752b8f commit 8515cad

File tree

1 file changed

+19
-8
lines changed

1 file changed

+19
-8
lines changed

README.md

Lines changed: 19 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -6,24 +6,35 @@ with the Freedesktop Dark-mode standard. It is named after and integrates with
66
standard. However, the plugin should work on all compliant desktop environments
77
(including Gnome and KDE).
88

9+
10+
## Maintenance status
11+
12+
darkman.nvim is relatively stable, so updates do not come regularly. There is no
13+
need to assume that the repository is unmaintained if an update hasn't occurred
14+
for several months. This section will change if the maintenance status for
15+
darkman.nvim changes.
16+
917
## Requirements
1018

11-
This plugin is currently in development, and no versions have been released.
12-
Thus, to compile darkman.nvim a go compiler is required.
19+
To compile darkman.nvim a go compiler is required due to
20+
4e554c4c/darkman.nvim#1. We are working on changing this, but it is currently
21+
impossible due to the architecture of common neovim package managers.
1322

1423
## Installation
1524

16-
Using [packer.nvim](https://github.com/wbthomason/packer.nvim)
25+
Using [lazy.nvim](https://github.com/folke/lazy.nvim)
1726
```lua
18-
use {
27+
{
1928
'4e554c4c/darkman.nvim',
20-
run = 'go build -o bin/darkman.nvim',
21-
config = function()
22-
require 'darkman'.setup()
23-
end,
29+
event = 'VimEnter',
30+
build = 'go build -o bin/darkman.nvim',
31+
opts = {
32+
-- configuration here
33+
},
2434
}
2535
```
2636

37+
2738
## Configuration
2839

2940
`setup` takes a dictionary of the following values (and defaults)

0 commit comments

Comments
 (0)