From 7fd078dcdb898b443afdfd0065247f332620119c Mon Sep 17 00:00:00 2001
From: mpl <mathieu.lonjaret@gmail.com>
Date: Sun, 29 Sep 2019 23:51:11 +0200
Subject: [PATCH] added README

---
 README.txt | 16 ++++++++++++++++
 main.go    |  2 ++
 2 files changed, 18 insertions(+)
 create mode 100644 README.txt

diff --git a/README.txt b/README.txt
new file mode 100644
index 0000000..becbb21
--- /dev/null
+++ b/README.txt
@@ -0,0 +1,16 @@
+gphotos-cdp
+========
+
+This program uses the Chrome DevTools Protocol to drive a Chrome session that
+downloads your photos stored in Google Photos.
+By default, it starts at the most ancient item in the library, and progresses
+towards the most recent.
+It can be run incrementally, as it keeps track of the last item that was
+downloaded.
+It only works with the main library for now, i.e. it does not support the photos
+moved to Archive, or albums.
+For each downloaded photo, an external program can be run on it (with the -run
+flag) right after it is downloaded to e.g. upload it somewhere else. See the
+upload/perkeep program, which uploads to a Perkeep server, for an example.
+
+
diff --git a/main.go b/main.go
index d07a7c2..af9070d 100644
--- a/main.go
+++ b/main.go
@@ -1,3 +1,5 @@
+// This program uses the Chrome DevTools Protocol to drive a Chrome session that
+// downloads your photos stored in Google Photos.
 package main
 
 import (