Skip to content

Commit ee04e4c

Browse files
committed
docs: update README
1 parent 6e39685 commit ee04e4c

File tree

1 file changed

+22
-0
lines changed

1 file changed

+22
-0
lines changed

README.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,35 @@
11
# 🍂 fall-extra
22

33
[![JSR](https://jsr.io/badges/@vim-fall/extra)](https://jsr.io/@vim-fall/extra)
4+
[![Deno](https://img.shields.io/badge/Deno%202.x-333?logo=deno&logoColor=fff)](#)
45
[![Test](https://github.com/vim-fall/fall-extra/actions/workflows/test.yml/badge.svg)](https://github.com/vim-fall/fall-extra/actions/workflows/test.yml)
56
[![MIT License](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE)
67

78
Extra library for using [Fall](https://github.com/vim-fall/fall), a Vim/Neovim
89
Fuzzy Finder plugin powered by
910
[Denops](https://github.com/vim-denops/denops.vim).
1011

12+
## Usage
13+
14+
Extensions are available in the root directory. You can access them like this:
15+
16+
```typescript
17+
import * as extra from "jsr:@vim-fall/extra";
18+
19+
// Display all sources
20+
console.log(extra.source);
21+
22+
// Display all renderers
23+
console.log(extra.renderer);
24+
25+
// Display all actions
26+
console.log(extra.action);
27+
```
28+
29+
For builtin extensions or utility functions, check out
30+
[vim-fall/fall-std](https://github.com/vim-fall/fall-std)
31+
([`@vim-fall/std`](https://jsr.io/@vim-fall/std)).
32+
1133
## License
1234

1335
The code in this repository follows the MIT license, as detailed in

0 commit comments

Comments
 (0)