@@ 1,6 1,10 @@
+[![tickets](https://img.shields.io/badge/tickets-here-informational?style=flat-square&color=0062CC)](https://todo.sr.ht/~tmpod/black-lite)
+[![mailing lists](https://img.shields.io/badge/mailing_lists-here-informational?style=flat-square&color=0062CC)](https://lists.sr.ht/~tmpod/black-lite)
+
# black-lite
-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.
+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
@@ 9,10 13,11 @@ Navigate to your `data/plugins` directory and then use one of the following meth
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
+ curl -O https://git.sr.ht/~tmpod/black-lite/blob/master/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.
+2. Clone this repository into your plugins folder. This allows you to easily update the plugin by doing `git pull` but
+it fetches unnecessary files, such as this README.
```
git clone https://git.sr.ht/~tmpod/black-lite
```
@@ 28,7 33,8 @@ A message in the status bar will appear letting you know if the `black` ran succ
## Configurations
This plugin has two configuration fields.
-You can set these configurations by editing your `init.lua` file in the `data/user` lite directory and modifying the `core.config` table.
+You can set these configurations by editing your `init.lua` file in the `data/user` lite directory and modifying the
+`core.config` table.
Each field name should be prefixed with `black_`, for example, `black_args`.
Here's a description of each valid configuration field: