Skip to content

Commit

Permalink
📝 Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
lambdalisue committed Jul 20, 2024
1 parent cecefc5 commit cbe82eb
Show file tree
Hide file tree
Showing 2 changed files with 38 additions and 11 deletions.
29 changes: 22 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,14 +3,29 @@
[![JSR](https://jsr.io/badges/@denops/core)](https://jsr.io/@denops/core)
[![test](https://github.com/vim-denops/deno-denops/workflows/test/badge.svg)](https://github.com/vim-denops/deno-denops/actions?query=workflow%3Atest)

This module is a fundamental component of [denops.vim], an ecosystem for
crafting plugins in [Deno] for Vim/Neovim.
This is a core module of [denops.vim], an ecosystem for creating Vim/Neovim
plugin in [Deno].

It's essential to highlight that the recommended practice for most users is to
utilize the [denops_std] module when developing plugins for [denops.vim]. The
current module is structured as a foundational layer within [denops_std], and
utilizing it directly from plugins is **strongly discouraged**.
> [!WARNING]
>
> This module is mainly for internal use. It's **strongly discouraged** to
> utilize this module directly from plugins. Use the [@denops/std] module
> instead.
```ts
import type { Entrypoint } from "jsr:@denops/core";

export const main: Entrypoint = (denops) => {
// ...
};
```

[deno]: https://deno.land/
[denops.vim]: https://github.com/vim-denops/denops.vim
[denops_std]: https://deno.land/x/denops_std
[@denops/std]: https://jsr.io/@denops/std

# License

The code follows the MIT license, as stated in [LICENSE](./LICENSE).
Contributors need to agree that any modifications sent to this repository follow
the license.
20 changes: 16 additions & 4 deletions mod.ts
Original file line number Diff line number Diff line change
@@ -1,12 +1,24 @@
/**
* This module is a fundamental component of [denops.vim], an ecosystem for crafting plugins in [Deno] for Vim/Neovim.
* This is a core module of [denops.vim], an ecosystem for creating Vim/Neovim
* plugin in [Deno].
*
* It's essential to highlight that the recommended practice for most users is to utilize the [denops_std] module when developing plugins for [denops.vim].
* The current module is structured as a foundational layer within [denops_std], and utilizing it directly from plugins is **strongly discouraged**.
* > [!WARNING]
* >
* > This module is mainly for internal use. It's **strongly discouraged** to
* > utilize this module directly from plugins. Use the [@denops/std] module
* > instead.
*
* ```ts
* import type { Entrypoint } from "jsr:@denops/core";
*
* export const main: Entrypoint = (denops) => {
* // ...
* };
* ```
*
* [deno]: https://deno.land/
* [denops.vim]: https://github.com/vim-denops/denops.vim
* [denops_std]: https://github.com/vim-denops/deno-denops-std
* [@denops/std]: https://jsr.io/@denops/std
*
* @module
*/
Expand Down

0 comments on commit cbe82eb

Please sign in to comment.