Skip to content

Commit 0ce5437

Browse files
committed
docs: add notice of maintenance
we're still developing neovim-flake :)
1 parent 9cb7239 commit 0ce5437

File tree

1 file changed

+27
-10
lines changed

1 file changed

+27
-10
lines changed

.github/README.md

Lines changed: 27 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,16 @@
11
<div align="center">
22
<img src="../assets/neovim-flake-logo-work.svg" alt="neovim-flake Logo" width="200">
33
</div>
4+
45
<h1 align="center">❄️ neovim-flake</h1>
6+
7+
<div align="center">
8+
<a>
9+
A highly modular, configurable, extensible and easy to use Neovim configuration wrapper written in Nix. Designed for flexibility and ease of use and with code quality in mind.
10+
</a>
11+
</div>
12+
<br/>
13+
514
<div align="center">
615
<p>
716
<a href="https://github.com/NotAShelf/neovim-flake/releases/latest">
@@ -27,14 +36,15 @@
2736
<p align="center">
2837
<img src="https://stars.medv.io/NotAShelf/neovim-flake.svg", title="stars"/>
2938
</p>
30-
31-
<div align="center">
32-
<a>
33-
A highly modular, configurable, extensible and easy to use Neovim configuration wrapper written in Nix. Designed for flexibility and ease of use, this flake allows you to easily configure your Neovim instance with a few lines of Nix code.
34-
</a>
3539
</div>
40+
<br/>
3641

37-
</div>
42+
> [!WARNING]
43+
> Main branch is only updated for small, non-breaking changes. For the latest version of neovim-flake, please see
44+
> [the list of branches](https://github.com/NotAShelf/neovim-flake/branches) or
45+
> [open pull requests](https://github.com/NotAShelf/neovim-flake/pulls?q=is%3Apr+is%3Aopen+sort%3Aupdated-desc).
46+
> neovim-flake, at the time, is still being actively developed - and will continue to be so for the foreseeable
47+
> future.
3848
3949
---
4050

@@ -80,13 +90,16 @@ nix run github:notashelf/neovim-flake#tidal
8090
Similar instructions will apply for `nix profile install`. However, you are recommended to instead use the module system as described in the manual.
8191

8292
> [!NOTE]
83-
> The `maximal` configuration is _massive_ and will take a while to build. To get a feel for the configuration, use the default `nix` or `tidal` configurations.
84-
> Should you choose to try out the `maximal` configuration, using the binary cache as described in the manual is _strongly_ recommended.
93+
> The `maximal` configuration is _massive_ and will take a while to build.
94+
> To get a feel for the configuration, use the default `nix` or `tidal` configurations.
95+
> Should you choose to try out the `maximal` configuration, using the binary cache as described
96+
> in the manual is _strongly_ recommended.
8597
8698
### Docker
8799

88-
As of version 0.5, an image for the `nix` output is published to Dockerhub and GitHub packages with each tagged release. If you do not have Nix installed
89-
on your system, you may run neovim within a container using your favorite tool.
100+
As of version 0.5, an image for the `nix` output is published to Dockerhub and GitHub packages with each tagged release. If you do not have Docker installed
101+
on your system, you may run neovim within a container using your favorite tool. You are still recommended to use `nix` instead of Docker.
102+
90103
The following command will open the current directory in neovim with necessary tools bootstrapped.
91104

92105
```console
@@ -191,3 +204,7 @@ I am grateful for their previous work and inspiration, and I wholeheartedly reco
191204
<br/>
192205

193206
---
207+
208+
<div align="right">
209+
<a href="#readme">Back to the Top</a>
210+
</div>

0 commit comments

Comments
 (0)