From 19ab7310fc95b3721269cb4e6696e4b4138ad719 Mon Sep 17 00:00:00 2001 From: Nick Sweeting Date: Sat, 24 Apr 2021 01:45:36 -0400 Subject: [PATCH] Update README.md --- README.md | 15 +++++++-------- 1 file changed, 7 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 9d2b723b..ee3f7965 100644 --- a/README.md +++ b/README.md @@ -54,24 +54,23 @@ The goal is to sleep soundly knowing the part of the internet you care about wil **📦  Get ArchiveBox with [Docker Compose (recommended)](#quickstart) / Docker, or `apt` / `brew` / `pip` ([see below](#quickstart)).** ```bash -# Use this auto setup script to get started, or follow the full Quickstart instructions below +# Use this auto setup script, or follow the full Quickstart instructions below curl -sSL 'https://get.archivebox.io' | bash ``` +**⤵️ See the [Quickstart](#quickstart) below for full instructions...** + +**🔢 Example usage: adding links to archive.** ```bash -# Basic usage -cd ~/archivebox # you can setup a data folder anywhere -archivebox init --setup # initialize a collection and create an admin user -archivebox add 'https://example.com' # add URLs one at a time via args / piped stdin -archivebox schedule --every=day --depth=1 https://example.com/rss.xml # or have it import URLs regularly on a schedule +archivebox add 'https://example.com' # add URLs one at a time via args / piped stdin +archivebox schedule --every=day --depth=1 https://example.com/rss.xml # or have it import URLs regularly on a schedule ``` +**🔢 Example usage: viewing the archived content.** ```bash archivebox server 0.0.0.0:8000 # use the interactive web UI archivebox list 'https://example.com' # use the CLI commands (--help for more) ls ./archive/*/index.json # or browse directly via the filesystem ``` -**⤵️ See the [Quickstart](#quickstart) below for more...** -


cli init screenshot