Skip to content

Commit 561f565

Browse files
committed
docs: update README to reflect command changes and new upload options
1 parent 7bf7873 commit 561f565

File tree

1 file changed

+5
-31
lines changed

1 file changed

+5
-31
lines changed

readme.md

Lines changed: 5 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -11,45 +11,19 @@
1111
- [PayPal Donation](https://www.paypal.com/donate/?hosted_button_id=VGU2SQE88T2T4)
1212

1313

14-
## **:warning: BREAKING CHANGES** Upgrading from `immich-go` 0.22 and earlier
15-
16-
`Immich-go` 0.23 and after adopts the double dashes `--option` Linux convention for command line options. Commands should be updated accordingly.
17-
18-
> ### Google photos takeout import
19-
> **prior 0.23**
20-
> ```
21-
> immich-go -server=URL -key=KEY upload -google-photos {path/to/files}
22-
> ```
23-
>
24-
> **0.23 and after**
25-
> ```
26-
> immich-go upload from-google-photos --server=URL --api-key=KEY {path/to/files}
27-
> ```
28-
29-
> ### Folder import
30-
>
31-
> **prior 0.23**
32-
> ```
33-
> immich-go -server=URL -key=KEY upload {path/to/files}
34-
> ```
35-
>
36-
> **0.23 and after**
37-
> ```
38-
> immich-go upload from-folder --server=URL --api-key=KEY {path/to/files}
39-
> ```
40-
41-
42-
43-
Read the documentation below for full details.
4414

4515
## What Makes Immich-Go Special?
4616

4717
### Simple Installation:
4818
* Immich-Go doesn't require NodeJS or Docker for installation. This makes it easy to get started, even for those less familiar with technical environments.
4919
* Immich-Go can run on either your workstation or a NAS.
5020

21+
### Upload your existing photo collection to your Immich server:
22+
* **Upload from Google Photos Takeouts:** Immich-Go can process massive archives downloaded from Google Photos using Google Takeout. It efficiently processes these archives while preserving valuable metadata like GPS location, capture date, and album information.
23+
* **Upload from iCloud Takeouts:** Immich-Go can upload photos from an iCloud takeout archive, preserving the date of capture and album information.
24+
5125
### Handles Large Photo Collections:
52-
* **Upload Large Google Photos Takeouts:** Immich-Go excels at handling massive archives downloaded from Google Photos using Google Takeout. It efficiently processes these archives while preserving valuable metadata like GPS location, capture date, and album information. Read the [best practices](#google-photos-best-practices) below for more information.
26+
* **Upload Large Google Photos Takeouts:** Users have reported successfully uploading archives of over 100,000 photos. Read the [best practices](#google-photos-best-practices) below for more information.
5327
* **Upload Collections:** You can upload photos directly from your computer folders, folder trees, and compressed ZIP archives.
5428
* **Is Duplicate-aware:** Immich-Go identifies and discards duplicate photos, keeping only the highest-quality version on the server.
5529
* **Archive Your Immich Server:** Write the content of your Immich server to a folder tree, ready to be archived or migrated to another server.

0 commit comments

Comments
 (0)