chore: Automated documentation update [skip ci] (#24)

Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
phorcys420 · Aug 6, 2024 · f40397c · f40397c
1 parent b934a6e
commit f40397c
Show file tree

Hide file tree

Showing 6 changed files with 39 additions and 8 deletions.
diff --git a/src/burp-suite/README.md b/src/burp-suite/README.md
@@ -1,5 +1,5 @@
 
-# Burp Suite (burp-suite)
+# Burp Suite (via Portswigger CDN) (burp-suite)
 
 A feature that installs Burp Suite
 

diff --git a/src/coder/README.md b/src/coder/README.md
@@ -0,0 +1,24 @@
+
+# Coder (via installation script) (coder)
+
+A feature that installs Coder
+
+## Example Usage
+
+```json
+"features": {
+    "ghcr.io/phorcys420/devcontainer-features/coder:1": {}
+}
+```
+
+## Options
+
+| Options Id | Description | Type | Default Value |
+|-----|-----|-----|-----|
+| version | Select the Coder version | string | latest |
+
+
+
+---
+
+_Note: This file was auto-generated from the [devcontainer-feature.json](https://github.com/phorcys420/devcontainer-features/blob/main/src/coder/devcontainer-feature.json).  Add additional notes to a `NOTES.md`._
diff --git a/src/cutter/README.md b/src/cutter/README.md
@@ -1,5 +1,5 @@
 
-# Cutter (cutter)
+# Cutter (via GitHub Releases) (cutter)
 
 A feature that installs Cutter
 
@@ -17,9 +17,13 @@ A feature that installs Cutter
 |-----|-----|-----|-----|
 | version | Select the Cutter version (either 'latest' or a GitHub release tag) | string | latest |
 | repository | Define the repository to grab releases from | string | rizinorg/cutter |
+| extractAppImage | Whether or not to extract the AppImage's contents | boolean | true |
 
-> [!WARNING]
-> AppImages require FUSE to run by default, you can either run `cutter --appimage-extract-and-run` to extract the AppImage instead of using FUSE.
+> [!NOTE]
+> Cutter only provides AppImages for Linux, and AppImages require FUSE to run.
+> By default, this feature extracts the contents of the AppImage.
+> If for some reason, you don't want this behavior, you can set `extractAppImage` to `false`.
+> To run cutter, run `cutter --appimage-extract-and-run` to extract the AppImage instead of using FUSE.
 > Otherwise, you'll have to grant more privileges to your container, either by adding `SYS_ADMIN` to `capAdd` or by setting `privileged` to `true` in your `devcontainer.json` file.
 
 ---

diff --git a/src/ghidra/README.md b/src/ghidra/README.md
@@ -1,5 +1,5 @@
 
-# Ghidra (ghidra)
+# Ghidra (via GitHub Releases) (ghidra)
 
 A feature that installs Ghidra
 
@@ -18,7 +18,8 @@ A feature that installs Ghidra
 | version | Select the Ghidra version (either 'latest' or a GitHub release tag) | string | latest |
 | repository | Define the repository to grab releases from | string | NationalSecurityAgency/ghidra |
 
-
+> [!NOTE]
+> This feature installs it's own JDK following the [official requirements](https://ghidra-sre.org/InstallationGuide.html#Requirements) using the [`java` feature](https://github.com/devcontainers/features/tree/main/src/java)
 
 ---
 

diff --git a/src/lib-common/README.md b/src/lib-common/README.md
@@ -17,7 +17,8 @@ A feature that contains the commonly used functions in devcontainer features to
 |-----|-----|-----|-----|
 | baseDir | Select the base directory where the library should be installed | string | /usr/share/phorcys-devcontainer-libraries |
 
-
+> [!NOTE]
+> This feature is meant to be used by other features as a library, not directly in a devcontainer template.
 
 ---
 

diff --git a/src/lib-github/README.md b/src/lib-github/README.md
@@ -17,7 +17,8 @@ A feature that contains utilities to fetch releases from GitHub
 |-----|-----|-----|-----|
 | baseDir | Select the base directory where the library should be installed | string | /usr/share/phorcys-devcontainer-libraries |
 
-
+> [!NOTE]
+> This feature is meant to be used by other features as a library, not directly in a devcontainer template.
 
 ---