mirrors/ArchiveBox
1
0
Fork 0
mirror of https://github.com/ArchiveBox/ArchiveBox.git synced 2025-05-16 16:14:28 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions

Update README.md

Browse source
This commit is contained in:
Nick Sweeting 2021-04-24 01:45:36 -04:00 • committed by GitHub
parent c2fbb18f2e
commit 19ab7310fc
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 7 additions and 8 deletions
Download patch file Download diff file Expand all files Collapse all files

11
README.md
View file

@ -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
```
**🔢 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...**
<div align="center">
<br/><br/>
<img src="https://i.imgur.com/njxgSbl.png" width="22%" alt="cli init screenshot" align="top">