Skip to content

Commit

Permalink
doc: minor
Browse files Browse the repository at this point in the history
  • Loading branch information
redstreet committed Aug 22, 2023
1 parent e09c759 commit 10d21a9
Showing 1 changed file with 19 additions and 3 deletions.
22 changes: 19 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,11 @@
# Git remote helper for rclone-supported services

This is a [Git remote helper](https://git-scm.com/docs/git-remote-helpers) for
backends supported by [rclone](https://rclone.org). In other words, this
helper makes it possible to push and pull to a large number of storage services
with no native Git support.
backends supported by [rclone](https://rclone.org).

This enables using `git pull` or `git push` with a remote git repository stored on
popular cloud services with no native Git support. Optionally, it enables using
zero-knowledge encryption via [rclone's crypt](https://rclone.org/crypt/).

## Installation and Usage

Expand All @@ -24,6 +26,19 @@ For example, if access to a DropBox account has been configured as an rclone-rem
named `mydropbox`, the URL `rclone://mydropbox/myrepository` identifies a remote
in a directory `myrepository/` under this DropBox account.

## Example
```
mkdir testrepo; cd testrepo
git init .
echo "Hello world." > xyz
git add xyz
git commit -m "Initial commit."
rclone mkdir mydropbox:test # Assuming 'mydropbox' has been configured
git remote add rclone://mydropbox/test
git remote add origin rclone://mydropbox/test
git push origin -u main
```

## Technical details

At the remote end, `git-remote-rclone` maintains a directory with two files:
Expand All @@ -49,6 +64,7 @@ and on push only).
- Google Drive
- Onedrive
- DropBox
- [Rclone crypt](https://rclone.org/crypt/)


## Acknowledgements
Expand Down

0 comments on commit 10d21a9

Please sign in to comment.