diff --git a/README.md b/README.md index 836ebdd..9dd9494 100644 --- a/README.md +++ b/README.md @@ -11,12 +11,12 @@ A NixOS-based system for managing the three types of data in a computer: ## Quick Start ```bash -# One-command setup (interactive) -nix run github:YOUR_USERNAME/ultimate-notetaking-sync-backup-system +# One-command setup from any git server +nix run 'git+ssh://git@your-server/you/usync.git' -# Or clone first -git clone https://github.com/YOUR_USERNAME/ultimate-notetaking-sync-backup-system.git -cd ultimate-notetaking-sync-backup-system +# Or clone first, then run +git clone git@your-server:you/usync.git +cd usync nix run . ``` @@ -26,8 +26,8 @@ nix run . ```bash # 1. Clone the repo -git clone https://github.com/YOUR_USERNAME/ultimate-notetaking-sync-backup-system.git -cd ultimate-notetaking-sync-backup-system +git clone git@your-server:you/usync.git +cd usync # 2. Run setup (one command - includes all dependencies) nix run . @@ -38,20 +38,20 @@ nix run . # 4. Push config to your git server cd ~/.config/usync/config -git remote add origin git@your-server:you/config.git +git remote add origin git@your-server:you/usync-config.git git push -u origin main ``` ### Additional Computers (Joining) ```bash -# One command with your git URL and age key -nix run github:YOUR_USERNAME/ultimate-notetaking-sync-backup-system +# One command from your git server +nix run 'git+ssh://git@your-server/you/usync.git' # Choose option [2], enter your git URL and age key # Or non-interactively: -nix develop -./setup +git clone git@your-server:you/usync.git && cd usync +nix run . -- ``` ### Mobile Device (Phone/Tablet) @@ -78,10 +78,10 @@ Add to your flake.nix inputs, then import the module: ```nix { - inputs.unsbs.url = "github:YOUR_USERNAME/ultimate-notetaking-sync-backup-system"; + inputs.usync.url = "git+ssh://git@your-server/you/usync.git"; # In your configuration: - imports = [ inputs.unsbs.nixosModules.default ]; + imports = [ inputs.usync.nixosModules.default ]; } ``` diff --git a/flake.nix b/flake.nix index bb43cf9..39d0de1 100644 --- a/flake.nix +++ b/flake.nix @@ -81,7 +81,7 @@ let pkgs = nixpkgsFor.${system}; setupScript = pkgs.writeShellApplication { - name = "unsbs-setup"; + name = "usync-setup"; runtimeInputs = with pkgs; [ git jq @@ -105,7 +105,7 @@ else echo "Error: Cannot find setup script" echo "Run from the repo directory, or clone it first:" - echo " git clone https://github.com/YOUR_USERNAME/ultimate-notetaking-sync-backup-system.git" + echo " git clone git@your-server:you/usync.git" exit 1 fi fi @@ -115,11 +115,11 @@ in { default = { type = "app"; - program = "${setupScript}/bin/unsbs-setup"; + program = "${setupScript}/bin/usync-setup"; }; setup = { type = "app"; - program = "${setupScript}/bin/unsbs-setup"; + program = "${setupScript}/bin/usync-setup"; }; } );