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 ca4b89d
Show file tree
Hide file tree
Showing 2 changed files with 28 additions and 6 deletions.
27 changes: 24 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,31 @@ This module is a fundamental component of [denops.vim], an ecosystem for
crafting plugins in [Deno] for Vim/Neovim.

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

[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

# Usage

> [!WARNING]
>
> 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) => {
// ...
};
```

# 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.
7 changes: 4 additions & 3 deletions mod.ts
Original file line number Diff line number Diff line change
@@ -1,12 +1,13 @@
/**
* This module is a fundamental component of [denops.vim], an ecosystem for crafting plugins in [Deno] for Vim/Neovim.
*
* 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**.
* 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**.
*
* [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 ca4b89d

Please sign in to comment.