Skip to content

Commit 016ca1e

Browse files
committed
docs: update instuctions
1 parent 236f96c commit 016ca1e

File tree

1 file changed

+45
-17
lines changed

1 file changed

+45
-17
lines changed

β€ŽREADME.md

Lines changed: 45 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@
2020
<a href="https://github.com/2KAbhishek/template.nvim/pulse">
2121
<img alt="Last Updated" src="https://img.shields.io/github/last-commit/2kabhishek/template.nvim?style=flat&color=e06c75&label="> </a>
2222

23-
<h3>Short Sweet Headline πŸŽ‡πŸŽ‰</h3>
23+
<h3>Ready to go Neovim template πŸ—οΈβœˆοΈ</h3>
2424

2525
<figure>
2626
<img src="doc/images/screenshot.png" alt="template.nvim in action">
@@ -30,7 +30,7 @@
3030

3131
</div>
3232

33-
template.nvim is a `<utility/tool>` that allows `<target_audience>` to `<action>`.
33+
template.nvim is a neovim plugin that allows `<target_audience>` to `<action>`.
3434

3535
## ✨ Features
3636

@@ -41,28 +41,55 @@ template.nvim is a `<utility/tool>` that allows `<target_audience>` to `<action>
4141

4242
### βš™οΈ Requirements
4343

44-
- foo >= bar
45-
- bazz
44+
- Latest version of `neovim`
4645

4746
### πŸ’» Installation
4847

49-
Installing template.nvim is as simple as cloning and symlinking!
48+
```lua
49+
-- Lazy
50+
{
51+
'2kabhishek/template.nvim',
52+
dependencies = {
53+
'nvim-lua/plenary.nvim'
54+
},
55+
cmd = 'TemplateHello',
56+
},
57+
58+
-- Packer
59+
use '2kabhishek/template.nvim'
5060

51-
```bash
52-
git clone https://github.com/2kabhishek/template.nvim
53-
cd template.nvim
54-
<install_command>
5561
```
5662

5763
## πŸš€ Usage
5864

59-
```bash
60-
USAGE:
61-
template.nvim [FLAGS] [OPTIONS]
62-
Example:
63-
template.nvim
65+
### Configuration
66+
67+
template.nvim can be configured using the following options:
68+
69+
```lua
70+
template.setup({
71+
name = 'template.nvim', -- Name to be greeted, 'World' by default
72+
})
6473
```
6574

75+
### Commands
76+
77+
`template.nvim` adds the following commands:
78+
79+
- `TemplateHello`: Shows a hello message with the confugred name.
80+
81+
### Keybindings
82+
83+
It is recommended to use:
84+
85+
- `<leader>th,` for `TemplateHello`
86+
87+
> NOTE: By default there are no configured keybindings.
88+
89+
### Help
90+
91+
Run `:help nerdy` for more details.
92+
6693
## πŸ—οΈ What's Next
6794

6895
Planning to add `<feature/module>`.
@@ -77,7 +104,7 @@ Planning to add `<feature/module>`.
77104

78105
### 🌈 Inspiration
79106

80-
template.nvim was inspired by `<reason/idea>`.
107+
template.nvim was inspired by [nvim-plugin-template](https://github.com/ellisonleao/nvim-plugin-template), I added some changes on top to make setting up a new plugin faster.
81108

82109
### πŸ’‘ Challenges/Learnings
83110

@@ -93,8 +120,9 @@ template.nvim was inspired by `<reason/idea>`.
93120

94121
### πŸ” More Info
95122

96-
- [shelly](https://github.com/2kabhishek/shelly) β€” Command line template
97-
- [tiny-web](https://github.com/2kabhishek/tiny-web) β€” Web app template
123+
- [nerdy.nvim](https://github.com/2kabhishek/nerdy.nevim) β€” Find nerd glyphs easily
124+
- [tdo.nvim](https://github.com/2KAbhishek/tdo.nvim) β€” Fast and simple notes in Neovim
125+
- [termim.nvim](https://github.com/2kabhishek/termim,nvim) β€” Neovim terminal improved
98126

99127
<hr>
100128

0 commit comments

Comments
Β (0)