From 516f8d68422b1996a1fc9fd6e5da587c9af97483 Mon Sep 17 00:00:00 2001
From: Eclypsed <116935158+Eclypsed@users.noreply.github.com>
Date: Tue, 15 Apr 2025 00:59:39 -0400
Subject: [PATCH] Update README.md

---
 README.md | 36 +++++++++++++++++++++++++++++++++++-
 1 file changed, 35 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index fb56fe0..c5140f7 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,36 @@
-# nix-jmu-cs345
 A nixos module for installing a pre-configured development environment for JMU's CS345
+## Setup
+### Using flakes
+Inside your main `flake.nix`
+```nix
+{
+  description = "System Configuration Flake";
+
+  inputs = {
+    nix-jmu-cs345.url = "githib:Eclypsed/nix-jmu-cs345/main";
+  };
+
+  outputs = { nix-jmu-cs345, ... }@inputs: {
+    nixosConfigurations = {
+      <your-hostname> = nixpkgs.lib.nixosSystem {
+        # ...
+        modules = [
+          nix-jmu-cs345.nixosModules.bernstdh
+        ];
+      };
+    };
+  };
+}
+```
+Then, in your `configuraiton.nix` (or whichever nix file you please)
+```nix
+programs.nix-jmu-cs345.enable = true;
+```
+
+## Details
+The developemnt environment is configured to include the following in accordance with the [CS345 Java Development Environment](https://w3.cs.jmu.edu/bernstdh/web/common/help/java-development-environment_setup.php). Note that currently the checkstyle and formatter configs will still have to be manually downloaded and configured within Eclipse.
+- OpenJDK v21
+- Eclipse IDE for Java Developers 2024-06 R
+- Checkstyle plugin for Eclipse v10.17
+- JUnit plugin for Eclipse v5.10
+- EclEmma plugin for Eclipse v3.1.9