Skip to content

Commit

Permalink
docs: add proper readme and more installtion instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
max397574 committed Oct 12, 2024
1 parent afd4415 commit 2dab7bc
Show file tree
Hide file tree
Showing 2 changed files with 35 additions and 6 deletions.
8 changes: 8 additions & 0 deletions docs/getting_started.md
Original file line number Diff line number Diff line change
Expand Up @@ -95,6 +95,14 @@ If you don't have rockspec support you need to install `fzy` as a dependency.

### Rocks.nvim

<details>
<summary>Installation instructions for rocks.nvim</summary>

You can simply run `:Rocks install care.nvim` and then add the keymapping
snippet to your config.

</details>

## Development

See the [devloper documentation](./dev) for more information about the code and
Expand Down
33 changes: 27 additions & 6 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,18 +4,39 @@

# care.nvim

[Documentation Website](https://max397574.github.io/care.nvim/)

</div>

initialized automatically
# ✨ Features

- Fully configurable menu
- Api for keybindings and various utilities
- Components for easy configuration of menu
- Compability with nvim-cmp sources with
[care-cmp](https://github.com/max397574/care-cmp)

# 🚀 Getting started

You can simply install care.nvim with your preferred plugin manager. There are
builtin sources for lsp and more comming soon.

Care is initialized automatically and lazy-loaded internally so there is no need
for lazy-loading nor calling setup.

use require"care.config".setup({...}) to configure
You can find more detailed installation instructions on the website
[here](https://max397574.github.io/care.nvim/getting_started).

## Credits

mariasolos for work in core and core in general
- [MariaSolOs](https://github.com/MariaSolOs) for work in core and core in
general

nvim-cmp was a big inspiration for this
- [nvim-cmp](https://github.com/hrsh7th/nvim-cmp) was a big inspiration for
this

mfussenegger for helping me out with my beginner questions
- [mfussenegger](https://github.com/mfussenegger) for helping me out with my
beginner questions

mrcjkb for helping me out with test infrastructure and luarocks setup
- [mrcjkb](https://github.com/mrcjkb) for helping me out with test
infrastructure and luarocks setup

0 comments on commit 2dab7bc

Please sign in to comment.