From d37aad40458d3130be5eb8290303e0e2bf13cc30 Mon Sep 17 00:00:00 2001 From: Nick Sweeting Date: Thu, 8 Apr 2021 07:43:09 -0400 Subject: [PATCH] Update README.md --- README.md | 37 ++++++++++++++++++++----------------- 1 file changed, 20 insertions(+), 17 deletions(-) diff --git a/README.md b/README.md index b34a0575..7a6021b8 100644 --- a/README.md +++ b/README.md @@ -38,27 +38,37 @@ It saves snapshots of the URLs you feed it as HTML, PDF, PNG screenshots, WARC, At the end of the day, the goal is to sleep soundly knowing the part of the internet you care about will be automatically preserved on your own machine. By saving sites in multiple, durable, long-term formats it ensures that content will be accessible and sharable for many decades to come without needing ArchiveBox or other specialized software to access it. +
+

+bookshelf graphic   logo   bookshelf graphic +

+Demo | Screenshots | Usage +
+. . . . . . . . . . . . . . . . . . . . . . . . . . . . +

+
+
-**🔢  First, get ArchiveBox using [Docker Compose (recommended)](#Quickstart), or Docker, Apt, Brew, Pip (see below for [instructions for each OS](#Quickstart)).** +**📦  First, get ArchiveBox using [Docker Compose (recommended)](#Quickstart), or Docker, Apt, Brew, Pip (see below for [instructions for each OS](#Quickstart)).** -*No matter which install method you choose, they all roughly follow this 3-step process and all provide the same CLI, Web UI, and on-disk data format.* +*No matter which install method you choose, they all roughly follow this process and all provide the same CLI, Web UI, and data folder layout.* 1. Once you have ArchiveBox, run this in a new empty folder to get started ```bash -archivebox init --setup # this creates a new collection +archivebox init --setup # create a new collection in the current directory ``` -2. Then add some URLs you want to archive +2. Add some URLs you want to archive ```bash -archivebox add 'https://example.com' # one at a time -curl https://example.com/rss.xml | archivebox add # piped via stdin -archivebox schedule --every=day https://example.com/rss.xml # frequent imports +archivebox add 'https://example.com' # add URLs one at a time via args or piped stdin + +archivebox schedule --every=day --depth=1 https://example.com/rss.xml # or pull in URLs on a schedule ``` -For each URL added, ArchiveBox saves several types of HTML snapshot (wget, Chrome headless, singlefile), a PDF, a screenshot, a WARC archive, any git repositories, images, audio, video, subtitles, article text, . +For each URL added, ArchiveBox saves several types of HTML snapshot (wget, Chrome headless, singlefile), a PDF, a screenshot, a WARC archive, git repositories, images, audio, video, subtitles, article text, and more. -3. Then view your archive collection +3. Then view your archived pages ```bash archivebox server 0.0.0.0:8000 # use the interactive web UI @@ -70,12 +80,6 @@ ls ./archive/*/index.json # or browse directly via the filesystem


-bookshelf graphic   logo   bookshelf graphic -

-Demo | Screenshots | Usage -
-. . . . . . . . . . . . . . . . . . . . . . . . . . . . -

cli init screenshot cli init screenshot server snapshot admin screenshot @@ -105,8 +109,7 @@ ls ./archive/*/index.json # or browse directly via the filesystem ### Quickstart -**🖥  Supported OSs:** Linux/BSD, macOS, Windows (w/ Docker or WSL/WSL2)     **🎮  CPU Architectures:** x86, amd64, arm7, arm8 (raspi >=3) -**📦  Distributions:** `docker`/`apt`/`brew`/`pip3` +**🖥  Supported OSs:** Linux/BSD, macOS, Windows (w/ Docker, WSL/WSL2)     **🎮  CPU Architectures:** x86, amd64, arm7, arm8 (raspi >=3)