From 4737988e5bb8acfc170e0790f25800fbfcfb4141 Mon Sep 17 00:00:00 2001 From: Nick Sweeting Date: Thu, 8 Apr 2021 07:31:47 -0400 Subject: [PATCH] Update README.md --- README.md | 31 +++++++++++++------------------ 1 file changed, 13 insertions(+), 18 deletions(-) diff --git a/README.md b/README.md index 54e62672..b34a0575 100644 --- a/README.md +++ b/README.md @@ -30,15 +30,19 @@
-ArchiveBox is a powerful internet archiving solution that works like a self-hosted Wayback Machine. You feed it URLs of pages you want to archive (as bookmarks, browser history, RSS, etc.), and it saves them to disk in a variety of formats depending on setup and content within. +ArchiveBox is a powerful internet archiving solution that works like a self-hosted Wayback Machine. You feed it URLs of pages you want to archive, and it saves them locally in a variety of formats depending on setup and content within. -It supports taking URLs in one at a time, or scheduled importing from browser bookmarks or history, RSS, services like Pocket/Pinboard and more. For a full list see input formats. +It supports taking URLs in one at a time, or scheduled importing from browser bookmarks/history, RSS, services like Pocket/Pinboard and more. For a full list see input formats. -It saves Snapshots of the URLs you feed it as HTML, PDFs, Screenshots, plain text, and more out-of-the-box, with a wide variety of content extracted and preserved automatically (audio/video, git repos, etc.). See output formats for a full list. +It saves snapshots of the URLs you feed it as HTML, PDF, PNG screenshots, WARC, and more out-of-the-box, with a wide variety of content extracted and preserved automatically (article text, audio/video, git repos, etc.). See output formats for a full list. -At the end of the day, the goal is to sleep soundly knowing that the part of the internet you care about will be automatically preserved in multiple, durable long-term formats that will be accessible and sharable for many decades. +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. -**🔢  First, get ArchiveBox via [Docker Compose (recommended)](#Quickstart), or Docker, Apt, Brew, Pip ([see below](#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.* 1. Once you have ArchiveBox, run this in a new empty folder to get started ```bash @@ -68,7 +72,7 @@ ls ./archive/*/index.json # or browse directly via the filesystem

bookshelf graphic   logo   bookshelf graphic

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

@@ -101,21 +105,12 @@ ls ./archive/*/index.json # or browse directly via the filesystem ### Quickstart -**🖥  Supported OSs:** Linux/BSD, macOS, Windows (w/ Docker)     **🎮  CPU Architectures:** x86, amd64, arm7, arm8 (raspi >=3) -**📦  Distributions:** `docker`/`apt`/`brew`/`pip3`/`npm` (in order of completeness) - -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. - -
    -
  1. Install ArchiveBox: apt/brew/pip3/etc install archivebox
    2. -
  2. Start a collection: archivebox init
    3. -
  3. Start archiving: archivebox add 'https://example.com'
    4. -
  4. View the archive: archivebox server or archivebox list ..., ls ./archive/*/index.html
    5. -
 +**🖥  Supported OSs:** Linux/BSD, macOS, Windows (w/ Docker or WSL/WSL2)     **🎮  CPU Architectures:** x86, amd64, arm7, arm8 (raspi >=3) +**📦  Distributions:** `docker`/`apt`/`brew`/`pip3`
-#### ⬇️  Install +#### ⬇️  Initial Setup *(click to expand your preferred **► `distribution`** below for full setup instructions)*