Merge pull request #190 from adamharrison/add-manifest

Add Manifest + Job to Generate Table

1 files changed, 22 insertions, 9 deletions

diff --git a/README.md b/README.md
index 4c4fc56..13dba2c 100644
--- a/README.md
+++ b/README.md
@@ -17,12 +17,24 @@ To install a plugin:
     *   MacOS `~/.config/lite-xl/plugins/`
     *   Windows `C:\Users\(username)\.config\lite-xl\plugins\`
 
-*Note: if you make a pull request, the table should be updated and kept in
-alphabetical order. If your plugin is large (or you'd otherwise prefer it to
-have its own repo), the table can simply be updated to add a link to the
-repo; otherwise the plugin file itself can be submitted. If a plugin's link
-resolves to something other than a raw file it should be marked with an
-asterisk.*
+Or, if you have a lite-xl plugin manager, such as [`lpm`](https://github.com/adamharrison/lite-xl-plugin-manager),
+you may install plugins by doing
+
+```
+  lpm install plugin_name
+```
+
+*Note: if you make a pull request, the manifest.json file should be updated to
+include any new plugins added, as specified in the [lite-xl plugin manifest specification]
+(https://github.com/adamharrison/lite-xl-plugin-manager/blob/master/SPEC.md).*
+
+*Please note, that in this official repository, any plugins that specify a `remote` must also
+pin the remote to a specific commit hash. Any plugin that is hosted not in a repository, 
+but only with a `url` must provide a `checksum` that matches the existing plugin.*
+
+*Any non-conforming PRs will not be accepted. The table below will be updated automatically.*
+
+*Any entries marked with an asterisk are hosted on external repositories.*
 
 ***
 
@@ -34,7 +46,7 @@ asterisk.*
 | [`autosaveonfocuslost`](plugins/autosaveonfocuslost.lua?raw=1)                                                 | Automatically saves files that were changed when the main window loses focus by switching to another application                                                                                                                                                                                 |
 | [`autowrap`](plugins/autowrap.lua?raw=1)                                                                       | Automatically hardwraps lines when typing                                                                                                                                                                                                                                                        |
 | [`bigclock`](plugins/bigclock.lua?raw=1)                                                                       | Shows the current time and date in a view with large text *([screenshot](https://user-images.githubusercontent.com/3920290/82752891-3318df00-9db9-11ea-803f-261d80d5cf53.png))*                                                                                                                  |
-| [`black`](https://git.sr.ht/\~tmpod/black-lite)\*                                                              | Integrates the [black](https://github.com/psf/black) Python formatter with lite                                                                                                                                                                                                                  |
+| [`black`](https://git.sr.ht/~tmpod/black-lite)\*                                                               | Integrates the [black](https://github.com/psf/black) Python formatter with lite                                                                                                                                                                                                                  |
 | [`bracketmatch`](plugins/bracketmatch.lua?raw=1)                                                               | Underlines matching pair for bracket under the caret *([screenshot](https://user-images.githubusercontent.com/3920290/80132745-0c863f00-8594-11ea-8875-c455c6fd7eae.png))*                                                                                                                       |
 | [`centerdoc`](plugins/centerdoc.lua?raw=1)                                                                     | Centers document's content on the screen and adds zen mode support *([screenshot](https://user-images.githubusercontent.com/3920290/82127896-bf6e4500-97ae-11ea-97fc-ba9a552bc9a4.png))*                                                                                                         |
 | [`colorpreview`](plugins/colorpreview.lua?raw=1)                                                               | Underlays color values (eg. `#ff00ff` or `rgb(255, 0, 255)`) with their resultant color. *([screenshot](https://user-images.githubusercontent.com/3920290/80743752-731bd780-8b15-11ea-97d3-847db927c5dc.png))*                                                                                   |
@@ -94,6 +106,7 @@ asterisk.*
 | [`language_go`](plugins/language_go.lua?raw=1)                                                                 | Syntax for the [Go](https://golang.org/) programming language                                                                                                                                                                                                                                    |
 | [`language_hlsl`](plugins/language_hlsl.lua?raw=1)                                                             | Syntax for the [HLSL](https://docs.microsoft.com/en-us/windows/win32/direct3dhlsl/dx-graphics-hlsl) programming language                                                                                                                                                                         |
 | [`language_hs`](plugins/language_hs.lua?raw=1)                                                                 | Syntax for the [Haskell](https://www.haskell.org/) programming language                                                                                                                                                                                                                          |
+| [`language_htaccess`](/plugins/language_htaccess.lua?raw=1)                                                    | Syntax for [.htaccess](https://httpd.apache.org/docs/2.4/howto/htaccess.html) files.                                                                                                                                                                                                             |
 | [`language_ignore`](https://github.com/anthonyaxenov/lite-xl-ignore-syntax)\*                                  | Syntax for [.gitignore](https://git-scm.com/docs/gitignore), [.dockerignore](https://docs.docker.com/engine/reference/builder/#dockerignore-file) and some other `.*ignore` files                                                                                                                |
 | [`language_ini`](plugins/language_ini.lua?raw=1)                                                               | Syntax for [ini](https://en.wikipedia.org/wiki/INI_file) files                                                                                                                                                                                                                                   |
 | [`language_java`](plugins/language_java.lua?raw=1)                                                             | Syntax for the [Java](https://en.wikipedia.org/wiki/Java_\(programming_language\)) programming language                                                                                                                                                                                          |
@@ -120,7 +133,7 @@ asterisk.*
 | [`language_pony`](https://github.com/MrAnyx/lite-plugin-pony)\*                                                | Syntax for [Pony](https://www.ponylang.io/) programming language                                                                                                                                                                                                                                 |
 | [`language_powershell`](plugins/language_powershell.lua?raw=1)                                                 | Syntax for [PowerShell](https://docs.microsoft.com/en-us/powershell) scripting language                                                                                                                                                                                                          |
 | [`language_psql`](plugins/language_psql.lua?raw=1)                                                             | Syntax for the postgresql database access language                                                                                                                                                                                                                                               |
-| [`language_r`](plugins/language_R.lua?raw=1)                                                                   | Syntax for [R](https://www.r-project.org/) scripting language                                                                                                                                                                                                                                    |
+| [`language_R`](plugins/language_R.lua?raw=1)                                                                   | Syntax for [R](https://www.r-project.org/) scripting language                                                                                                                                                                                                                                    |
 | [`language_rescript`](plugins/language_rescript.lua?raw=1)                                                     | Syntax for the [ReScript](https://rescript-lang.org/) programming language                                                                                                                                                                                                                       |
 | [`language_rivet`](plugins/language_rivet.lua?raw=1)                                                           | Syntax for the [Rivet](https://github.com/rivet-lang/rivet) programming language                                                                                                                                                                                                                 |
 | [`language_ruby`](plugins/language_ruby.lua?raw=1)                                                             | Syntax for the [Ruby](https://www.ruby-lang.org/) programming language                                                                                                                                                                                                                           |
@@ -174,7 +187,7 @@ asterisk.*
 | [`spellcheck`](plugins/spellcheck.lua?raw=1)                                                                   | Underlines misspelt words *([screenshot](https://user-images.githubusercontent.com/3920290/79923973-9caa7400-842e-11ea-85d4-7a196a91ca50.png))* *-- note: on Windows a [`words.txt`](https://github.com/dwyl/english-words/blob/master/words.txt) dictionary file must be placed beside the exe* |
 | [`statusclock`](plugins/statusclock.lua?raw=1)                                                                 | Displays the current date and time in the corner of the status view                                                                                                                                                                                                                              |
 | [`tab_switcher`](plugins/tab_switcher.lua?raw=1)                                                               | Switch between open tabs by searching by name                                                                                                                                                                                                                                                    |
-| [`tabnumbers`](plugins/tabnumbers.lua?raw=1)                                                                   | Displays tab numbers from 1–9 next to their names \*([screenshot](https://user-images.githubusercontent.com/16415678/101285362-007a8500-37e5-11eb-869b-c10eb9d9d902.png))                                                                                                                        |
+| [`tabnumbers`](plugins/tabnumbers.lua?raw=1)                                                                   | Displays tab numbers from 1–9 next to their names \*([screenshot](https://user-images.githubusercontent.com/16415678/101285362-007a8500-37e5-11eb-869b-c10eb9d9d902.png))                                                                                                                      |
 | [`texcompile`](plugins/texcompile.lua?raw=1)                                                                   | Compile Tex files into PDF                                                                                                                                                                                                                                                                       |
 | [`theme16`](https://github.com/monolifed/theme16)\*                                                            | Theme manager with base16 themes                                                                                                                                                                                                                                                                 |
 | [`themeselect`](plugins/themeselect.lua?raw=1)                                                                 | Select a theme based on filename of active document                                                                                                                                                                                                                                              |