M README.md => README.md +15 -0
@@ 3,6 3,21 @@
A simple plugin for [lite](https://github.com/rxi/lite) that adds a command and keybind to run [`black`](https://github.com/psf/black) on the current file.
+## Installing
+
+Navigate to your `data/plugins` directory and then use one of the following methods:
+
+1. Just download the plugin file into your plugins folder.
+ ```
+ curl https://git.sr.ht/~tmpod/black-lite/blob/master/black.lua -o black.lua
+ ```
+
+2. Clone this repository into your plugins folder. This allows you to easily update the pluin by doing `git pull` but it fetches unnecessary files, such as this README.
+ ```
+ git clone https://git.sr.ht/~tmpod/black-lite
+ ```
+
+
## Usage
The plugin is very easy to use, you just have to either run the `Black: Format` command, or hit `Alt+L`.
A init.lua => init.lua +2 -0
@@ 0,0 1,2 @@
+require "plugins.black.black"
+