Skip to content

Commit 3cdcea7

Browse files
committed
Update README.md on installation instructions
Dropped the advice to just download `index.js` and `jump.kak` files, because this will also require renaming it to `.mjs` extension, and then we'd need to introduce more error checking and it's so tedious it's not really worth it. I guess people who really want to avoid cloning the whole repo can figure out these Node intricacies on their own.
1 parent 1c62770 commit 3cdcea7

File tree

2 files changed

+7
-5
lines changed

2 files changed

+7
-5
lines changed

README.md

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -20,12 +20,14 @@ You should have [node](https://github.com/nodejs/node) installed and available i
2020

2121
## Installation
2222

23-
1. Either:
24-
- Clone the repository
25-
- Download just the files `index.js` and `jump.kak`.
26-
You can put them anywhere you want as long as they happen to be in the same directory and `index.js` is called `index.js`.
23+
Just clone the repository into your `autoload/` folder.
2724

28-
2. Source the file `jump.kak` in your `kakrc`.
25+
If you clone it elsewhere, you will also need to source the file `jump.kak`.
26+
For example, you can add this command to your `kakrc`:
27+
28+
```kakscript
29+
source path/to/plugin/jump.kak
30+
```
2931

3032
## Usage
3133

jump-mode.kak renamed to jump.kak

File renamed without changes.

0 commit comments

Comments
 (0)