From 1e04fa8108551a699f79706953af2ef581e0676b Mon Sep 17 00:00:00 2001 From: Nick Sweeting Date: Mon, 23 Nov 2020 23:44:18 -0500 Subject: [PATCH] Update README.md --- README.md | 29 +++++++++++------------------ 1 file changed, 11 insertions(+), 18 deletions(-) diff --git a/README.md b/README.md index baa56826..0f2fc5f2 100644 --- a/README.md +++ b/README.md @@ -49,18 +49,6 @@ brew install archivebox/archivebox/archivebox # or for the Python version only, without wget/git/chrome/etc. included pip3 install archivebox -``` - -Check that everything installed correctly with: -```bash -archivebox --version -``` - -**To start using archivebox, you have to create a data folder and `cd` into it:** - -```bash -mkdir ~/archivebox && cd ~/archivebox # you can put the collection dir anywhere -archivebox init # If you're using an apt/brew/pip install you can run archivebox commands normally # archivebox [subcommand] [...args] @@ -70,22 +58,27 @@ archivebox init # docker-compose run archivebox [subcommand] [...args] ``` +Check that everything installed correctly with `archivebox --version` + +**To start using archivebox, you have to create a data folder and `cd` into it:** + +```bash +mkdir ~/archivebox && cd ~/archivebox # you can put the collection dir anywhere +archivebox init +``` + **Then Add some URLs to your archive collection:** ```bash archivebox add https://github.com/ArchiveBox/ArchiveBox archivebox/archivebox add --depth=1 https://example.com ``` -View the snapshots of the URLs you added via the self-hosted web UI: +**View the snapshots of the URLs you added via the self-hosted web UI:** ```bash archivebox manage createsuperuser # create an admin acct archivebox server 0.0.0.0:8000 # start the web server open http://127.0.0.1:8000/ # open the interactive admin panel -``` - -Or just browse the snapshots statically on disk: -```bash -ls ~/archivebox/archive/*/index.html +ls ~/archivebox/archive/*/index.html # or browse the snapshots on disk ```