diff --git a/README.md b/README.md new file mode 100644 index 0000000..11cc813 --- /dev/null +++ b/README.md @@ -0,0 +1,30 @@ +# croc + +Easily and securely send things from one computer to another + + + +- **Category**: Utilities +- **Status**: βΆπŸ’š +- **Image**: [`croc`](https://hub.docker.com/r/schollz/croc),βΆπŸ’š, upstream +- **Healthcheck**: No +- **Backups**: No +- **Email**: No +- **Tests**: No +- **SSO**: No + + + +## Basic usage + +1. Set up Docker Swarm and [`abra`] +2. `abra app new croc` +3. `abra app secret generate -a ` - this will generate server password +4. `abra app deploy ` +done! + +now you can use croc. Remember to put your password when sending/receiving files! +`croc --pass SERVER_PASSWORD --relay "server.address:9009" send [filename]` to send +`croc --pass SERVER_PASSWORD --relay "server.address:9009"` to receive + +[`abra`]: https://git.coopcloud.tech/coop-cloud/abra