Skip to content

Commit

Permalink
Tidy README
Browse files Browse the repository at this point in the history
  • Loading branch information
AlecRust committed Oct 25, 2023
1 parent f7876b2 commit a4c7ea0
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 7 deletions.
15 changes: 9 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,22 +1,25 @@
# gphotos-takeout-repair [![CI](https://github.com/AlecRust/gphotos-takeout-repair/actions/workflows/ci.yml/badge.svg)](https://github.com/AlecRust/gphotos-takeout-repair/actions/workflows/ci.yml) [![npm version](https://badge.fury.io/js/gphotos-takeout-repair.svg)](https://badge.fury.io/js/gphotos-takeout-repair)

Transform a Google Photos export (created with [Takeout](https://takeout.google.com/)) into a more useful folder(s) of images.
Transform a Google Photos export (created with [Takeout](https://takeout.google.com/)) into a useful folder(s) of files.

The output is a folder of files (with folder structure retained) suitable for use as a traditional photo library, where there are no JSON files, no "edited" versions, and the files have suitable `Date Created` timestamps.

For example the following files within the source directory:
For example given the following files in the source directory:

| Filename | Date Created | Description |
| ------------------- | ------------------- | ----------------------------- |
| IMG_0001-edited.JPG | Takeout export date | Edited version of the file |
| IMG_0001.JPG | Takeout export date | Original version of the file |
| IMG_0001.json | Takeout export date | Metadata information for file |
| IMG_0002.mp4 | Takeout export date | Original version of the file |
| IMG_0002.json | Takeout export date | Metadata information for file |

Will result in the following file output to the destination directory:
The output in the destination directory will be:

| Filename | Date Created | Description |
| ------------ | ---------------------------- | -------------------------- |
| IMG_0001.JPG | "Photo taken" date from JSON | Edited version of the file |
| Filename | Date Created | Description |
| ------------ | ---------------------------- | ---------------------------- |
| IMG_0001.JPG | "Photo taken" date from JSON | Edited version of the file |
| IMG_0002.mp4 | "Photo taken" date from JSON | Original version of the file |

## Features

Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "gphotos-takeout-repair",
"version": "1.0.0",
"description": "CLI tool to transform a Google Photos export into a useful folder of files.",
"description": "Transform a Google Photos export (created with Takeout) into a useful folder(s) of files.",
"author": "Alec Rust <me@alecrust.com>",
"license": "ISC",
"main": "src/index.js",
Expand Down

0 comments on commit a4c7ea0

Please sign in to comment.