Skip to content

Commit

Permalink
docs: update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
2KAbhishek committed Nov 14, 2024
1 parent 0c046ff commit 2119cc9
Showing 1 changed file with 24 additions and 24 deletions.
48 changes: 24 additions & 24 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,36 +1,36 @@
<div align = "center">

<h1><a href="https://github.com/2kabhishek/template.nvim">template.nvim</a></h1>
<h1><a href="https://github.com/2kabhishek/exercism.nvim">exercism.nvim</a></h1>

<a href="https://github.com/2KAbhishek/template.nvim/blob/main/LICENSE">
<img alt="License" src="https://img.shields.io/github/license/2kabhishek/template.nvim?style=flat&color=eee&label="> </a>
<a href="https://github.com/2KAbhishek/exercism.nvim/blob/main/LICENSE">
<img alt="License" src="https://img.shields.io/github/license/2kabhishek/exercism.nvim?style=flat&color=eee&label="> </a>

<a href="https://github.com/2KAbhishek/template.nvim/graphs/contributors">
<img alt="People" src="https://img.shields.io/github/contributors/2kabhishek/template.nvim?style=flat&color=ffaaf2&label=People"> </a>
<a href="https://github.com/2KAbhishek/exercism.nvim/graphs/contributors">
<img alt="People" src="https://img.shields.io/github/contributors/2kabhishek/exercism.nvim?style=flat&color=ffaaf2&label=People"> </a>

<a href="https://github.com/2KAbhishek/template.nvim/stargazers">
<img alt="Stars" src="https://img.shields.io/github/stars/2kabhishek/template.nvim?style=flat&color=98c379&label=Stars"></a>
<a href="https://github.com/2KAbhishek/exercism.nvim/stargazers">
<img alt="Stars" src="https://img.shields.io/github/stars/2kabhishek/exercism.nvim?style=flat&color=98c379&label=Stars"></a>

<a href="https://github.com/2KAbhishek/template.nvim/network/members">
<img alt="Forks" src="https://img.shields.io/github/forks/2kabhishek/template.nvim?style=flat&color=66a8e0&label=Forks"> </a>
<a href="https://github.com/2KAbhishek/exercism.nvim/network/members">
<img alt="Forks" src="https://img.shields.io/github/forks/2kabhishek/exercism.nvim?style=flat&color=66a8e0&label=Forks"> </a>

<a href="https://github.com/2KAbhishek/template.nvim/watchers">
<img alt="Watches" src="https://img.shields.io/github/watchers/2kabhishek/template.nvim?style=flat&color=f5d08b&label=Watches"> </a>
<a href="https://github.com/2KAbhishek/exercism.nvim/watchers">
<img alt="Watches" src="https://img.shields.io/github/watchers/2kabhishek/exercism.nvim?style=flat&color=f5d08b&label=Watches"> </a>

<a href="https://github.com/2KAbhishek/template.nvim/pulse">
<img alt="Last Updated" src="https://img.shields.io/github/last-commit/2kabhishek/template.nvim?style=flat&color=e06c75&label="> </a>
<a href="https://github.com/2KAbhishek/exercism.nvim/pulse">
<img alt="Last Updated" src="https://img.shields.io/github/last-commit/2kabhishek/exercism.nvim?style=flat&color=e06c75&label="> </a>

<h3>Ready to go Neovim template 🏗️✈️</h3>

<figure>
<img src="doc/images/screenshot.png" alt="template.nvim in action">
<img src="doc/images/screenshot.png" alt="exercism.nvim in action">
<br/>
<figcaption>template.nvim in action</figcaption>
<figcaption>exercism.nvim in action</figcaption>
</figure>

</div>

template.nvim is a neovim plugin that allows neovim users to `<action>`.
exercism.nvim is a neovim plugin that allows neovim users to `<action>`.

## ✨ Features

Expand All @@ -51,18 +51,18 @@ template.nvim is a neovim plugin that allows neovim users to `<action>`.
```lua
-- Lazy
{
'2kabhishek/template.nvim',
'2kabhishek/exercism.nvim',
cmd = 'TemplateHello',
-- Add your custom configs here, keep it blank for default configs (required)
opts = {},
-- Use this for local development
-- dir = '~/path-to/template.nvim',
-- dir = '~/path-to/exercism.nvim',
},
```

## 🚀 Usage

1. Fork the `template.nvim` repo
1. Fork the `exercism.nvim` repo
2. Update the plugin name, file names etc, change `template` to `your-plugin-name`
3. Add the code required for your plugin,
- Code entrypoint is [template.lua](./lua/template.lua)
Expand All @@ -77,17 +77,17 @@ template.nvim is a neovim plugin that allows neovim users to `<action>`.

### Configuration

template.nvim can be configured using the following options:
exercism.nvim can be configured using the following options:

```lua
template.setup({
name = 'template.nvim', -- Name to be greeted, 'World' by default
name = 'exercism.nvim', -- Name to be greeted, 'World' by default
})
```

### Commands

`template.nvim` adds the following commands:
`exercism.nvim` adds the following commands:

- `TemplateHello`: Shows a hello message with the confugred name.

Expand Down Expand Up @@ -117,7 +117,7 @@ Planning to add `<feature/module>`.

### 🌈 Inspiration

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.
exercism.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.

### 💡 Challenges/Learnings

Expand All @@ -143,7 +143,7 @@ template.nvim was inspired by [nvim-plugin-template](https://github.com/ellisonl

<strong>⭐ hit the star button if you found this useful ⭐</strong><br>

<a href="https://github.com/2KAbhishek/template.nvim">Source</a>
<a href="https://github.com/2KAbhishek/exercism.nvim">Source</a>
| <a href="https://2kabhishek.github.io/blog" target="_blank">Blog </a>
| <a href="https://twitter.com/2kabhishek" target="_blank">Twitter </a>
| <a href="https://linkedin.com/in/2kabhishek" target="_blank">LinkedIn </a>
Expand Down

0 comments on commit 2119cc9

Please sign in to comment.