From ade783c5998cc65c42e341ce545fb7a7cb7a7188 Mon Sep 17 00:00:00 2001 From: Nick Sweeting Date: Mon, 23 Nov 2020 23:39:08 -0500 Subject: [PATCH] Update README.md --- README.md | 11 ++++++++--- 1 file changed, 8 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index a17f4bc2..9cf2e0c3 100644 --- a/README.md +++ b/README.md @@ -59,16 +59,21 @@ archivebox --version **To start using archivebox, you have to create a data folder and `cd` into it:** ```bash -mkdir ~/archivebox && cd ~/archivebox # pick somewhere to put your data folder +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 like this: `archivebox [subcommand] [...args]` -If you're using Docker it's equivalent to run the commands like this: +If you're using Docker it's equivalent to run the commands like this: `docker run -v $PWD:/data -it archivebox/archivebox [subcommand] [...args]` -And the same in Docker Compose: +And the same in Docker Compose: `docker-compose run archivebox [subcommand] [...args]` + + **Then Add some URLs to your archive collection:** ```bash archivebox add https://github.com/ArchiveBox/ArchiveBox