Skip to content

Commit

Permalink
docs: readme
Browse files Browse the repository at this point in the history
  • Loading branch information
neurosnap committed Aug 17, 2024
1 parent 524df70 commit c06524b
Showing 1 changed file with 10 additions and 4 deletions.
14 changes: 10 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,10 @@
# pobj

`rsync`, `scp`, `sftp` for your object store. No extra front-end CLI tools
`rsync`, `scp`, `sftp`, and `sshfs` for your object store. No extra front-end CLI tools
necessary, use what you already have installed.

All you need to get started is our golang binary and an object store.

# supported object stores

Currently support object stores:
Expand All @@ -19,16 +21,16 @@ at [pico.sh](http://pico.sh).
# demo

```bash
make build
./build/authorized_keys
go run ./cmd/authorized_keys
```

Separate terminal:

```bash
rsync -e "ssh -p 2222" -r ./files localhost:/
rsync -e "ssh -p 2222" -rv ./files localhost:/
scp -P 2222 -r ./files localhost:/
sftp -P 2222 localhost
sshfs -p 2222 localhost:/ ./objs
```

# info
Expand All @@ -49,3 +51,7 @@ ghcr.io/picosh/pobj/pobj:latest
```

We also have a [docker compose file](./docker-compose.yml) which uses `minio`.

# inspiration

- [rclone](https://github.com/rclone/rclone)

0 comments on commit c06524b

Please sign in to comment.