add: some documentation

Author: carsakiller

README.md

@@ -0,0 +1,7 @@
+# LLS-Addons-Action
+A custom GitHub action that is used by [LLS-Addons](https://github.com/carsakiller/LLS-Addons) to get some metadata on addons such as their size and if they contain a plugin.
+
+This is ***very*** niche so there is probably no other use case than when being used by [LLS-Addons](https://github.com/carsakiller/LLS-Addons).
+
+## How it works
+It expects that the repo has been [checked out](https://github.com/actions/checkout), **including its submodules**. It will then get a list of all submodules, get their metadata, and then write it to their `info.json` file. This allows the addon manager of [vscode-lua](https://github.com/sumneko/vscode-lua) to have metadata on the addon without pulling the whole submodule first.

src/index.ts

@@ -5,6 +5,10 @@ import * as fs from "fs";
 
 const submoduleRegex = /([A-z0-9]+) (.*\/.*) .*/g;
 
+/** Calculate the size of a directory, recursively
+ * @param directory The path to the directory
+ * @return The size of the directory in bytes
+ */
 async function getDirectorySize(directory: string): Promise<number> {
   let totalSize = 0;
 
@@ -38,7 +42,9 @@ async function run() {
       const info = JSON.parse(rawInfo.toString());
 
       info.size = await getDirectorySize(submodulePath);
-      info.hasPlugin = fs.existsSync(path.join(submodulePath, "module", "plugin.lua"));
+      info.hasPlugin = fs.existsSync(
+        path.join(submodulePath, "module", "plugin.lua")
+      );
 
       fs.promises.writeFile(infoFilePath, JSON.stringify(info, null, "  "));
     }