docs: update readme & style

This commit is contained in:
NotAShelf 2023-02-06 05:32:13 +03:00
parent c2affb9945
commit 1f779aa81a
No known key found for this signature in database
GPG key ID: 5B5C8895F28445F1

View file

@ -15,7 +15,6 @@
<img alt="Repo Size" src="https://img.shields.io/github/repo-size/NotAShelf/neovim-flake?color=%23DDB6F2&label=SIZE&logo=codesandbox&style=for-the-badge&logoColor=D9E0EE&labelColor=302D41" />
</a>
<p align="center">
<img src="https://stars.medv.io/NotAShelf/neovim-flake.svg", title="commits"/>
</p>
@ -25,24 +24,31 @@ An Nix wrapped IDE layer for the superior text editor, Neovim.
---
**[<kbd><br>Install<br></kbd>][Install]**
**[<kbd><br>Configure<br></kbd>][Configure]**
**[<kbd><br>Documentation<br></kbd>][Documentation]**
**[<kbd><br>Configure<br></kbd>][Configure]**
**[<kbd><br>Documentation<br></kbd>][Documentation]**
**[<kbd><br>Contribute<br></kbd>][Contribute]**
**[<kbd><br>FAQ<br></kbd>][Faq]**
[Contribute]: #contributing
[Install]: #install
[Configure]: #configure
[Documentation]: #documentation
[FAQ]: #faq
---
A highly configurable nix flake for Neovim, packing everything you might need to create your own neovim IDE.
## Install
**Using `nix`**
### Using `nix`
The easiest way to install is to use the `nix profile` command. To install the default configuration, run:
```console
nix run github:notashelf/neovim-flake
```
The package exposes `.#nix` as the default output. You may use `.#nix`, `.#tidal` or `.#maximal` to get different configurations.
It is as simply as changing the target output to get a different configuration. For example, to get a configuration with `tidal` support, run:
@ -53,7 +59,7 @@ nix run github:notashelf/neovim-flake#tidal
Similar instructions will apply for `nix profile install`.
**On NixOS**
### On NixOS
NixOS users may add this repo to their flake inputs as such: