Skip to content

Commit f2e580d

Browse files
committed
Update README images
1 parent 3f48d75 commit f2e580d

6 files changed

+7
-4
lines changed

README.md

+7-4
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ There are 3 ways to use the auto-archiver:
2020
But **you always need a configuration/orchestration file**, which is where you'll configure where/what/how to archive. Make sure you read [orchestration](#orchestration).
2121

2222

23-
## How to run the auto-archiver
23+
## How to install and run the auto-archiver
2424

2525
### Option 1 - docker
2626

@@ -200,16 +200,19 @@ Outputs:
200200
* **WACZ**: Link to a WACZ web archive of post
201201
* **ReplayWebpage**: Link to a ReplayWebpage viewer of the WACZ archive
202202

203-
For example, for use with this spreadsheet:
203+
For example, this is a spreadsheet configured with all of the columns for the auto archiver and a few URLs to archive. (Note that the column names are not case sensitive.)
204204

205-
![A screenshot of a Google Spreadsheet with column headers defined as above, and several Youtube and Twitter URLs in the "Media URL" column](docs/demo-before.png)
205+
![A screenshot of a Google Spreadsheet with column headers defined as above, and several Youtube and Twitter URLs in the "Link" column](docs/demo-before.png)
206206

207207
When the auto archiver starts running, it updates the "Archive status" column.
208-
![A screenshot of a Google Spreadsheet with column headers defined as above, and several Youtube and Twitter URLs in the "Media URL" column. The auto archiver has added "archive in progress" to one of the status columns.](docs/demo-progress.png)
208+
![A screenshot of a Google Spreadsheet with column headers defined as above, and several Youtube and Twitter URLs in the "Link" column. The auto archiver has added "archive in progress" to one of the status columns.](docs/demo-progress.png)
209209
The links are downloaded and archived, and the spreadsheet is updated to the following:
210210
![A screenshot of a Google Spreadsheet with videos archived and metadata added per the description of the columns above.](docs/demo-after.png)
211211
Note that the first row is skipped, as it is assumed to be a header row (`--gsheet_feeder.header=1` and you can change it if you use more rows above). Rows with an empty URL column, or a non-empty archive column are also skipped. All sheets in the document will be checked.
212212

213+
The "archive location" link contains the path of the archived file, in local storage, S3, or in Google Drive.
214+
215+
![The archive result for a link in the demo sheet.](docs/demo-archive.png)
213216

214217
---
215218
## Development

docs/auto-auto.png

-183 KB
Binary file not shown.

docs/demo-after.png

1.02 MB
Loading

docs/demo-archive.png

819 KB
Loading

docs/demo-before.png

442 KB
Loading

docs/demo-progress.png

457 KB
Loading

0 commit comments

Comments
 (0)