diff --git a/README.md b/README.md index df02fa1..7203d45 100644 --- a/README.md +++ b/README.md @@ -3,13 +3,27 @@ End to end encrypted cloud clipboard. # Installation -Download the prebuilt latest release binary for your OS/arch and ensure that it's in your path. +Download the prebuilt latest release binary for your OS/arch and ensure that it's in your PATH. + +I just do `sudo mv ccclip /usr/local/bin` for either MacOS or Linux. # Configuration By default, ccclip looks for a ccclip directory in the [user home directory](https://pkg.go.dev/os#UserHomeDir) and it'll store the configuration file and device keys there. You don't need to do anything if you want to stores your config in the default location; to override this behavior, use the `--config-dir` global flag. +If you're onboarding a new device (with an already created account) then you should pre-populate your config file (ccclip.yaml in your config dir) to look like this: +```json +{"Email":"{your-email}","DeviceId":""} +``` +Yes, I know, the extension is yaml but the file has JSON. I'll change it, don't worry. + +It's also a good idea to creat an alias for the command, here's what I do in my `.zshrc`: +``` +alias ccc="ccclip" +``` +`ccc` is very fun to type, but choose whatever alias make you happy. + # Instructions ### Create an account with @@ -23,7 +37,7 @@ Passwords are stored as bcrypt hashes in the server. ### Register your device ```bash -ccclip register. +ccclip register-device ``` This will prompt you for your password. An [X25519](https://pkg.go.dev/crypto/ecdh) key pair is created and stored in your configuration directory. @@ -39,3 +53,5 @@ There's a caveat: When a clipboard is created, the sending device encrypts the d individually. This means that if you register a new device, it won't immediately have access to the current clipboard because its public key wasn't available when the clipboard was created. The benefit of this is that your data is end-to-end encrypted and I'll never be able to see it nor an attacker if we're compromised :) + +If you want your new device to have access to the current clipboard contents then just run `ccclip | ccclip` from an onboarded device.