From 2cddb61877ff74dba93fb6234352adc57952eb1a Mon Sep 17 00:00:00 2001 From: Nick Sweeting Date: Tue, 23 Jan 2024 18:27:48 -0800 Subject: [PATCH] Update README.md --- README.md | 49 +++++++++++++++++++++++++++++++++++++++---------- 1 file changed, 39 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index aa7a92b8..881ffa1a 100644 --- a/README.md +++ b/README.md @@ -426,26 +426,48 @@ cd ~/archivebox/data # IMPORTANT: cd into the directory # archivebox [subcommand] [--args] ``` -#### Bare Metal Usage (`pip`/`apt`/`brew`/etc.) -```bash +##### Bare Metal Usage (`pip`/`apt`/`brew`/etc.) + +
+
+Click to expand... +
+ +

 archivebox init --setup      # safe to run init multiple times (also how you update versions)
 archivebox version           # get archivebox version info and more
 archivebox add --depth=1 'https://news.ycombinator.com'
-```
+
+
+
##### Docker Compose Usage -```bash + +
+Click to expand... +
+ +

 # make sure you have `docker-compose.yml` from the Quickstart instructions first
 docker compose run archivebox init --setup
 docker compose run archivebox version
 docker compose run archivebox add --depth=1 'https://news.ycombinator.com'
-```
+
-#### Docker Usage -```bash +
+ +##### Docker Usage + +
+Click to expand... +
+ +

 docker run -v $PWD:/data -it archivebox/archivebox init --setup
 docker run -v $PWD:/data -it archivebox/archivebox version
-```
+
+ +
#### Next Steps @@ -458,14 +480,21 @@ docker run -v $PWD:/data -it archivebox/archivebox version > Whether in Docker or not, ArchiveBox commands all work the same way, and can be used in tandem to access the same data directory. > For example, you can run the Web UI in Docker Compose, and run one-off commands on host with `pip`-installed ArchiveBox or in Docker interchangeably. -```bash +
+
+Expand to show example... +
+ +

 docker compose up -d                                      # start the Web UI server in the background
 docker compose run archivebox add 'https://example.com'   # add a test URL to snapshot w/ Docker Compose
 
 archivebox list 'https://example.com'                     # fetch it with pip-installed archivebox on the host
 docker compose run archivebox list 'https://example.com'                       # or w/ Docker Compose
 docker run -it -v $PWD:/data archivebox/archivebox list 'https://example.com'  # or w/ Docker, all equivalent
-```
+
+ +
#### 🖥  Web UI Usage