Skip to content

Commit cbe82eb

Browse files
committed
📝 Update docs
1 parent cecefc5 commit cbe82eb

File tree

2 files changed

+38
-11
lines changed

2 files changed

+38
-11
lines changed

README.md

Lines changed: 22 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -3,14 +3,29 @@
33
[![JSR](https://jsr.io/badges/@denops/core)](https://jsr.io/@denops/core)
44
[![test](https://github.com/vim-denops/deno-denops/workflows/test/badge.svg)](https://github.com/vim-denops/deno-denops/actions?query=workflow%3Atest)
55

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

9-
It's essential to highlight that the recommended practice for most users is to
10-
utilize the [denops_std] module when developing plugins for [denops.vim]. The
11-
current module is structured as a foundational layer within [denops_std], and
12-
utilizing it directly from plugins is **strongly discouraged**.
9+
> [!WARNING]
10+
>
11+
> This module is mainly for internal use. It's **strongly discouraged** to
12+
> utilize this module directly from plugins. Use the [@denops/std] module
13+
> instead.
14+
15+
```ts
16+
import type { Entrypoint } from "jsr:@denops/core";
17+
18+
export const main: Entrypoint = (denops) => {
19+
// ...
20+
};
21+
```
1322

1423
[deno]: https://deno.land/
1524
[denops.vim]: https://github.com/vim-denops/denops.vim
16-
[denops_std]: https://deno.land/x/denops_std
25+
[@denops/std]: https://jsr.io/@denops/std
26+
27+
# License
28+
29+
The code follows the MIT license, as stated in [LICENSE](./LICENSE).
30+
Contributors need to agree that any modifications sent to this repository follow
31+
the license.

mod.ts

Lines changed: 16 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,24 @@
11
/**
2-
* This module is a fundamental component of [denops.vim], an ecosystem for crafting plugins in [Deno] for Vim/Neovim.
2+
* This is a core module of [denops.vim], an ecosystem for creating Vim/Neovim
3+
* plugin in [Deno].
34
*
4-
* 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].
5-
* The current module is structured as a foundational layer within [denops_std], and utilizing it directly from plugins is **strongly discouraged**.
5+
* > [!WARNING]
6+
* >
7+
* > This module is mainly for internal use. It's **strongly discouraged** to
8+
* > utilize this module directly from plugins. Use the [@denops/std] module
9+
* > instead.
10+
*
11+
* ```ts
12+
* import type { Entrypoint } from "jsr:@denops/core";
13+
*
14+
* export const main: Entrypoint = (denops) => {
15+
* // ...
16+
* };
17+
* ```
618
*
719
* [deno]: https://deno.land/
820
* [denops.vim]: https://github.com/vim-denops/denops.vim
9-
* [denops_std]: https://github.com/vim-denops/deno-denops-std
21+
* [@denops/std]: https://jsr.io/@denops/std
1022
*
1123
* @module
1224
*/

0 commit comments

Comments
 (0)