From ef5ab2d53ffda2407621e820912d1e047c58e400 Mon Sep 17 00:00:00 2001 From: Nick Sweeting Date: Fri, 23 Apr 2021 18:37:57 -0400 Subject: [PATCH] better list formatting --- README.md | 92 ++++++++++++++++++++++++++++++------------------------- 1 file changed, 51 insertions(+), 41 deletions(-) diff --git a/README.md b/README.md index f1adfe3f..e9e32977 100644 --- a/README.md +++ b/README.md @@ -121,46 +121,48 @@ ls ./archive/*/index.json # or browse directly via the filesyste Get ArchiveBox with docker-compose on macOS/Linux/Windows ✨ (highly recommended)
    -
  1. First make sure you have Docker and Docker Compose installed on your system.
    2. +
  2. Install Docker and Docker Compose on your system (if not already installed).
  3. Download the docker-compose.yml file into a new empty directory somewhere. 
    curl -O 'https://raw.githubusercontent.com/ArchiveBox/ArchiveBox/master/docker-compose.yml'
-docker-compose run archivebox init --setup
    4. -
  4. Run the initial setup. +
  5. Run the initial setup and create an admin user. 
    docker-compose run archivebox init --setup
    6. -
  6. Optional: Start the server then open the web UI http://127.0.0.1:8000. +
  7. Optional: start the server then open the web UI http://127.0.0.1:8000. 
    
 docker-compose up
-See below for more usage examples using the CLI, Web UI, and filesystem/SQL/Python to add URLs and manage your archive. +See below for more usage examples using the CLI, Web UI, or filesystem/SQL/Python manage your archive.

Get ArchiveBox with docker on macOS/Linux/Windows
-First make sure you have Docker installed on your system. - -
# create a new empty directory and initalize your collection (can be anywhere)
-mkdir ~/archivebox && cd ~/archivebox
+
    
+
  1. Install Docker on your system (if not already installed).
    2. 
+
  2. Create a new empty directory and initalize your collection (can be anywhere).
+
    mkdir ~/archivebox && cd ~/archivebox
 docker run -v $PWD:/data -it archivebox/archivebox init --setup
 
    
-
-Optional: Start the server then open the web UI http://127.0.0.1:8000.
+
    3. 
+
  3. Optional: Start the server then open the web UI http://127.0.0.1:8000.
 
    docker run -v $PWD:/data -p 8000:8000 archivebox/archivebox
 
    
+
    4. 
+

 
-See below for more usage examples using the CLI, Web UI, and filesystem/SQL/Python to add URLs and manage your archive.
+See below for more usage examples using the CLI, Web UI, or filesystem/SQL/Python manage your archive.
Get ArchiveBox with apt on Ubuntu/Debian
- +
    +
  1. Add the Apt sources and install the package. On Ubuntu >= 20.04, add the apt sources automatically: 
    sudo apt install software-properties-common
 sudo add-apt-repository -u ppa:archivebox/archivebox
@@ -172,62 +174,70 @@ sudo apt-key adv --keyserver keyserver.ubuntu.com --recv-keys C258F79DCC02E369
 sudo apt update
    -Then install the apt package and continue the setup: +Then install the apt package: 
    sudo apt install archivebox
-
-# create a new empty directory and initalize your collection (can be anywhere)
-mkdir ~/archivebox && cd ~/archivebox
+
    +
    2. +
  2. Create a new empty directory and initalize your collection (can be anywhere). +
    mkdir ~/archivebox && cd ~/archivebox
 archivebox init --setup           # if any problems, install with pip instead
    - -Optional: Start the server then open the web UI http://127.0.0.1:8000. +
    3. +
  3. Optional: Start the server then open the web UI http://127.0.0.1:8000. 
    archivebox server 0.0.0.0:8000
-
    +
    4. +
-See below for more usage examples using the CLI, Web UI, and filesystem/SQL/Python to add URLs and manage your archive. +See below for more usage examples using the CLI, Web UI, or filesystem/SQL/Python manage your archive.

Get ArchiveBox with brew on macOS
-First make sure you have Homebrew installed on your system. - -
# install the archivebox package using homebrew
-brew install archivebox/archivebox/archivebox
-
-# create a new empty directory and initalize your collection (can be anywhere)
-mkdir ~/archivebox && cd ~/archivebox
+
    
+
  1. Install Homebrew on your system (if not already installed).
    2. 
+
  2. Install the archivebox package using homebrew.
+
    brew install archivebox/archivebox/archivebox
+
+
    3. 
+
  3. Create a new empty directory and initalize your collection (can be anywhere).
+
    mkdir ~/archivebox && cd ~/archivebox
 archivebox init --setup         # if any problems, install with pip instead
 
    
-
-Optional: Start the server then open the web UI http://127.0.0.1:8000.
+
    4. 
+
  4. Optional: Start the server then open the web UI http://127.0.0.1:8000.
 
    archivebox server 0.0.0.0:8000
 
    
+
    5. 
+

 
-See below for more usage examples using the CLI, Web UI, and filesystem/SQL/Python to add URLs and manage your archive.
+See below for more usage examples using the CLI, Web UI, or filesystem/SQL/Python manage your archive.
Get ArchiveBox with pip on any other platforms (some extras must be installed manually)
-First make sure you have Python >= v3.7 and Node >= v14 installed. - -
# install the archivebox package using pip3
-pip3 install archivebox
-
-# create a new empty directory and initalize your collection (can be anywhere)
-mkdir ~/archivebox && cd ~/archivebox
+
    
+
  1. Install Python >= v3.7 and Node >= v14 on your system (if not already installed).
    2. 
+
  2. Install the archivebox package using pip3.
+
    pip3 install archivebox
+
    
+
    3. 
+
  3. Create a new empty directory and initalize your collection (can be anywhere).
+
    mkdir ~/archivebox && cd ~/archivebox
 archivebox init --setup
 # Install any missing extras like wget/git/ripgrep/etc. manually as needed
 
    
-
-Optional: Start the server then open the web UI http://127.0.0.1:8000.
+
    4. 
+
  4. Optional: Start the server then open the web UI http://127.0.0.1:8000.
 
    archivebox server 0.0.0.0:8000
 
    
+
    5. 
+

 
-See below for more usage examples using the CLI, Web UI, and filesystem/SQL/Python to add URLs and manage your archive.
+See below for more usage examples using the CLI, Web UI, or filesystem/SQL/Python manage your archive.