From 90ec5218f28ec52d3d44c9a213fd6ab518ecc5e2 Mon Sep 17 00:00:00 2001
From: xenia <xenia@ccs.neu.edu>
Date: Tue, 9 Apr 2024 16:51:38 -0400
Subject: [PATCH] update readme documentation

---
 README.md | 59 ++++++++++++++++++++++++++++++++++++++++++++-----------
 1 file changed, 48 insertions(+), 11 deletions(-)

diff --git a/README.md b/README.md
index 9e08bab..c69a01d 100644
--- a/README.md
+++ b/README.md
@@ -18,18 +18,55 @@ dragnpkgs provides a set of nixos modules and a nixpkgs overlay containing custo
 }
 ```
 
-## overview
+## documentation
+
+documentation for options provided by dragnpkgs
+
+
+### [`services.ghidra-server`](./modules/ghidra-server)
+the shared project server for [ghidra](https://ghidra-sre.org)  
+
+example usage:
+```nix
+services.ghidra-server = {
+  enable = true;
+  host = "your.domain.or.ip";
+};
+```
+
+#### services.ghidra-server.enable
+
+enables the ghidra server service
+
+#### services.ghidra-server.enableAdminCli
+
+adds a system package for the CLI tool `ghidra-svrAdmin`, which allows anyone in the `ghidra` group
+to administer the server (this corresponds to the `server/svrAdmin` tool in the stock ghidra
+distribution)
+
+#### services.ghidra-server.{package, jdkPackage} (`ghidra`, `openjdk17`)
+
+allows overriding the ghidra package and jdk package used for the server
+
+#### services.ghidra-server.host
+
+the server hostname or IP; this is typically required (by java RMI) for correct operation
+
+#### services.ghidra-server.basePort (`13100`)
+
+the server will use 3 consecutive TCP ports starting from this port
+
+#### services.ghidra-server.directory (`/var/lib/ghidra-server`)
+
+the root directory for server files
+
+#### services.ghidra-server.{user,group} (`ghidra`)
+
+the service user and group
+
+
+### more coming soon(tm)
 
-- [ghidra server](./modules/ghidra-server): the shared project server for
-    [ghidra](https://ghidra-sre.org)  
-    example usage:
-    ```nix
-    services.ghidra-server = {
-      enable = true;
-      host = "your.domain.or.ip";
-    };
-    ```
-- more coming soon(tm)
 
 ## licensing