From f2b63501c1581fb67dded3ab300575d01e5aa8e8 Mon Sep 17 00:00:00 2001
From: imnyang <imnyang@pm.me>
Date: Fri, 8 May 2026 05:27:03 +0900
Subject: [PATCH] docs: update README with module usage, add binary cache
 configuration to flake, and fix typo in vscode-insiders workflow

---
 .forgejo/workflows/update-vscode-insiders.yml |  4 +-
 README.md                                     | 53 ++++++++++++++++++-
 flake.nix                                     |  9 ++++
 3 files changed, 63 insertions(+), 3 deletions(-)

diff --git a/.forgejo/workflows/update-vscode-insiders.yml b/.forgejo/workflows/update-vscode-insiders.yml
index 52f455c..33c1486 100644
--- a/.forgejo/workflows/update-vscode-insiders.yml
+++ b/.forgejo/workflows/update-vscode-insiders.yml
@@ -12,7 +12,7 @@ jobs:
       - name: Checkout code
         uses: actions/checkout@v4
 
-      - name: Check for new vscode-insiderss release
+      - name: Check for new vscode-insiders release
         id: check
         run: |
           source /etc/bashrc
@@ -56,7 +56,7 @@ jobs:
         if: steps.check.outputs.updated == 'true'
         run: |
           source /etc/bashrc
-          NIXPKGS_ALLOW_UNFREE=1 nix build .#vscode-insiderss
+          NIXPKGS_ALLOW_UNFREE=1 nix build .#vscode-insiders
 
       - name: Create Pull Request
         if: steps.check.outputs.updated == 'true'
diff --git a/README.md b/README.md
index 322b0b8..4cf4e13 100644
--- a/README.md
+++ b/README.md
@@ -1,6 +1,16 @@
 # imnyang Nix Packages
 imnyang's custom nixpkgs overlay.
 
+## Included Packages
+- `helium`: Helium AppImage wrapper
+- `helium-sync`: Helium Sync utility
+- `vscode-insiders`: VSCode Insiders
+- `waterfox-bin`: Waterfox Browser
+- `xcursor-mizuki`: Custom cursor
+- `pjsk-cursor`: Custom cursor
+
+[Build Status](https://git.mizuki.guru/imnyang/nix-packages/actions)
+
 ## Usage
 Add the following to your nix configuration:
 
@@ -19,5 +29,46 @@ Add the following to your nix configuration:
     {
       # use some packages
     };
-}
 
+    nixConfig = {
+      extra-substituters = [
+        "https://cache.mizuki.guru/public"
+      ];
+      extra-trusted-public-keys = [
+        "cache.mizuki.guru:IgipakDD/clr0XbuaIejPYMT5UkTVGKVTxtWXcsbiAg="
+      ];
+    };
+}
+```
+
+## Modules
+
+### helium-sync
+
+#### NixOS
+```nix
+{
+  inputs.imnyang.url = "git+https://git.mizuki.guru/imnyang/nix-packages.git";
+  outputs = { self, nixpkgs, imnyang }: {
+    nixosConfigurations.my-host = nixpkgs.lib.nixosSystem {
+      modules = [
+        imnyang.nixosModules.helium-sync
+      ];
+    };
+  };
+}
+```
+
+#### Home Manager
+```nix
+{
+  inputs.imnyang.url = "git+https://git.mizuki.guru/imnyang/nix-packages.git";
+  outputs = { self, home-manager, imnyang, ... }: {
+    homeConfigurations.my-user = home-manager.lib.homeManagerConfiguration {
+      modules = [
+        imnyang.homeManagerModules.helium-sync
+      ];
+    };
+  };
+}
+```
diff --git a/flake.nix b/flake.nix
index b0a1454..bb164b2 100644
--- a/flake.nix
+++ b/flake.nix
@@ -41,5 +41,14 @@
       
       default = pkgs.helium; # 예시로 하나를 기본값으로 지정
     };
+
+    nixConfig = {
+      extra-substituters = [
+        "https://cache.mizuki.guru/public"
+      ];
+      extra-trusted-public-keys = [
+        "cache.mizuki.guru:IgipakDD/clr0XbuaIejPYMT5UkTVGKVTxtWXcsbiAg="
+      ];
+    };
   };
 }
\ No newline at end of file