Skip to content

Commit 5c888df

Browse files
committed
update readme
1 parent 74c4568 commit 5c888df

File tree

1 file changed

+6
-3
lines changed

1 file changed

+6
-3
lines changed

README.md

+6-3
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,14 @@
44
[![Build & Publish NPM Package](https://github.com/WeeJeWel/node-icloud-backup/actions/workflows/npm-publish.yml/badge.svg)](https://github.com/WeeJeWel/node-icloud-backup/actions/workflows/npm-publish.yml)
55
[![Build & Publish Docker Image](https://github.com/WeeJeWel/node-icloud-backup/actions/workflows/ghcr-publish.yml/badge.svg)](https://github.com/WeeJeWel/node-icloud-backup/actions/workflows/ghcr-publish.yml)
66

7-
This module automatically downloads your iCloud Drive to the filesystem.
7+
This module automatically downloads your iCloud Drive to the local filesystem.
88

99
This tool will output the following directory structure:
1010

1111
```
1212
.
13-
├── Drive
13+
└── Drive
14+
└── <...>
1415
```
1516

1617
## Why?
@@ -32,14 +33,16 @@ $ npx -y icloud-backup \
3233
--filepath "~/Backups/iCloud/"
3334
```
3435

36+
> The first time you will need to enter your 2FA code manually.
37+
3538
> Hint: You can schedule this in a cronjob for automated backups.
3639
3740
#### Docker
3841

3942
If you prefer Docker, this is an example how to run:
4043

4144
```bash
42-
$ docker run \
45+
$ docker run -it \
4346
--env ICLOUD_BACKUP_USERNAME="john.doe@gmail.com" \
4447
--env ICLOUD_BACKUP_PASSWORD="abcd efgh ijkl mnop" \
4548
--env ICLOUD_BACKUP_FILEPATH="/backups" \

0 commit comments

Comments
 (0)