Rename to usync, use generic git URLs

- Rename app binary from unsbs-setup to usync-setup
- Update README to use git+ssh:// URLs for custom git servers
- Remove GitHub-specific references

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
This commit is contained in:
2026-02-13 08:24:34 -05:00
parent 521a2431c2
commit cb55be1324
2 changed files with 18 additions and 18 deletions

View File

@@ -11,12 +11,12 @@ A NixOS-based system for managing the three types of data in a computer:
## Quick Start ## Quick Start
```bash ```bash
# One-command setup (interactive) # One-command setup from any git server
nix run github:YOUR_USERNAME/ultimate-notetaking-sync-backup-system nix run 'git+ssh://git@your-server/you/usync.git'
# Or clone first # Or clone first, then run
git clone https://github.com/YOUR_USERNAME/ultimate-notetaking-sync-backup-system.git git clone git@your-server:you/usync.git
cd ultimate-notetaking-sync-backup-system cd usync
nix run . nix run .
``` ```
@@ -26,8 +26,8 @@ nix run .
```bash ```bash
# 1. Clone the repo # 1. Clone the repo
git clone https://github.com/YOUR_USERNAME/ultimate-notetaking-sync-backup-system.git git clone git@your-server:you/usync.git
cd ultimate-notetaking-sync-backup-system cd usync
# 2. Run setup (one command - includes all dependencies) # 2. Run setup (one command - includes all dependencies)
nix run . nix run .
@@ -38,20 +38,20 @@ nix run .
# 4. Push config to your git server # 4. Push config to your git server
cd ~/.config/usync/config 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 git push -u origin main
``` ```
### Additional Computers (Joining) ### Additional Computers (Joining)
```bash ```bash
# One command with your git URL and age key # One command from your git server
nix run github:YOUR_USERNAME/ultimate-notetaking-sync-backup-system nix run 'git+ssh://git@your-server/you/usync.git'
# Choose option [2], enter your git URL and age key # Choose option [2], enter your git URL and age key
# Or non-interactively: # Or non-interactively:
nix develop git clone git@your-server:you/usync.git && cd usync
./setup <git-url> <your-age-key> nix run . -- <config-git-url> <your-age-key>
``` ```
### Mobile Device (Phone/Tablet) ### Mobile Device (Phone/Tablet)
@@ -78,10 +78,10 @@ Add to your flake.nix inputs, then import the module:
```nix ```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: # In your configuration:
imports = [ inputs.unsbs.nixosModules.default ]; imports = [ inputs.usync.nixosModules.default ];
} }
``` ```

View File

@@ -81,7 +81,7 @@
let let
pkgs = nixpkgsFor.${system}; pkgs = nixpkgsFor.${system};
setupScript = pkgs.writeShellApplication { setupScript = pkgs.writeShellApplication {
name = "unsbs-setup"; name = "usync-setup";
runtimeInputs = with pkgs; [ runtimeInputs = with pkgs; [
git git
jq jq
@@ -105,7 +105,7 @@
else else
echo "Error: Cannot find setup script" echo "Error: Cannot find setup script"
echo "Run from the repo directory, or clone it first:" 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 exit 1
fi fi
fi fi
@@ -115,11 +115,11 @@
in { in {
default = { default = {
type = "app"; type = "app";
program = "${setupScript}/bin/unsbs-setup"; program = "${setupScript}/bin/usync-setup";
}; };
setup = { setup = {
type = "app"; type = "app";
program = "${setupScript}/bin/unsbs-setup"; program = "${setupScript}/bin/usync-setup";
}; };
} }
); );