From 6733388c8692c73a3f772890ed0ce46f13bba795 Mon Sep 17 00:00:00 2001 From: Nick Sweeting Date: Wed, 20 Jan 2021 15:24:10 -0500 Subject: [PATCH] Update README.md --- README.md | 51 ++++++++++++++++++++++++++++----------------------- 1 file changed, 28 insertions(+), 23 deletions(-) diff --git a/README.md b/README.md index 05072589..d9b2dd13 100644 --- a/README.md +++ b/README.md @@ -35,6 +35,20 @@ You can use `archivebox schedule` to ingest URLs regularly from your browser boo Archived content is browseable and managable locally with the CLI commands like `archivebox status` or `archivebox list ...`, via the built-in web UI `archivebox server`, directly through the filesystem `./archive/` folders, or via the [Python API](https://docs.archivebox.io/en/latest/modules.html) (alpha) or [REST API](https://github.com/ArchiveBox/ArchiveBox/issues/496) (alpha). +
+. . . . . . . . . . . . . . . . . . . . . . . . . . . . +
+Demo | Usage +
+. . . . . . . . . . . . . . . . . . . . . . . . . . . . +
+CLI Screenshot +Desktop index screenshot +Desktop details page Screenshot +Desktop details page Screenshot
+
+
+ ### Quickstart It works on Linux/BSD (Intel and ARM CPUs with `docker`/`apt`/`pip3`), macOS (with `docker`/`brew`/`pip3`), and Windows (beta with `docker`/`pip3`). @@ -222,6 +236,20 @@ archivebox help # to see more options For more information, see the full Quickstart guide, Usage, and Configuration docs. +--- + + +# Overview + +ArchiveBox is a command line tool, self-hostable web-archiving server, and Python library all-in-one. It can be installed on Docker, macOS, and Linux/BSD, and Windows. You can download and install it as a Debian/Ubuntu package, Homebrew package, Python3 package, or a Docker image. No matter which install method you choose, they all provide the same CLI, Web UI, and on-disk data format. + +To use ArchiveBox you start by creating a folder for your data to live in (it can be anywhere on your system), and running `archivebox init` inside of it. That will create a sqlite3 index and an `ArchiveBox.conf` file. After that, you can continue to add/export/manage/etc using the CLI `archivebox help`, or you can run the Web UI (recommended). If you only want to archive a single site, you can run `archivebox oneshot` to avoid having to create a whole collection. + +The [CLI](https://github.com/ArchiveBox/ArchiveBox/wiki/Usage#CLI-Usage) is considered "stable", the ArchiveBox [Python API](https://docs.archivebox.io/en/latest/modules.html) and [REST API](https://github.com/ArchiveBox/ArchiveBox/issues/496) are "alpha", and the [desktop app](https://github.com/ArchiveBox/desktop) is "alpha". + +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 for decades (or longer). You can also self-host your archivebox server on a public domain to provide archive.org-style public access to your site snapshots. + +## Screenshots
@@ -259,29 +287,6 @@ For more information, see the -CLI Screenshot -Desktop index screenshot -Desktop details page Screenshot -Desktop details page Screenshot
-
Demo | Usage -
-. . . . . . . . . . . . . . . . . . . . . . . . . . . . -
- ## Key Features