diff --git a/README.md b/README.md index 75208349..9dd8a1af 100644 --- a/README.md +++ b/README.md @@ -30,13 +30,13 @@ Without active preservation effort, everything on the internet eventually dissap
docker-compose
(macOS/Linux/Windows) 👈 recommended (click to expand)homebr
pacman
/
pkg
/
nix
(Arch/FreeBSD/NixOS/more)
-> [!WARNING]
-> *These are contributed by external volunteers and may lag behind the official `pip` channel.*
+> *Warning: These are contributed by external volunteers and may lag behind the official `pip` channel.*
- Arch:
yay -S archivebox
(contributed by @imlonghao
)
@@ -374,11 +373,10 @@ See below for usage examples using the CLI, W
+# make sure you have pip-installed ArchiveBox and it's available in your $PATH first
+
+# archivebox [subcommand] [--args]
archivebox init --setup # safe to run init multiple times (also how you update versions)
archivebox version # get archivebox version info + check dependencies
archivebox help # get list of archivebox subcommands that can be run
@@ -487,6 +488,8 @@ archivebox add --depth=1 'https://news.ycombinator.com'
# make sure you have `docker-compose.yml` from the Quickstart instructions first
+
+# docker compose run archivebox [subcommand [--args]
docker compose run archivebox init --setup
docker compose run archivebox version
docker compose run archivebox help
@@ -501,6 +504,9 @@ docker compose run archivebox add --depth=1 'https://news.ycombinator.com'
Docker CLI Usage Examples
+# make sure you create and cd into in a new empty directory first
+
+# docker run -it -v $PWD:/data archivebox/archivebox [subcommand [--args]
docker run -v $PWD:/data -it archivebox/archivebox init --setup
docker run -v $PWD:/data -it archivebox/archivebox version
docker run -v $PWD:/data -it archivebox/archivebox help
@@ -604,21 +610,20 @@ docker run -it -v $PWD:/data archivebox/archivebox add --depth=1 'https://exampl
## Input Formats: How to pass URLs into ArchiveBox for saving
--
The official ArchiveBox Browser Extension
- Provides realtime archiving from Chrome/Chromium/Firefox browsers
+-
The official ArchiveBox Browser Extension
+ Provides realtime archiving of all browsing history or selected pages only from Chrome/Chromium/Firefox browsers
-
Manual imports of URLs from RSS, JSON, CSV, TXT, SQL, HTML, Markdown
- ArchiveBox supports injecting URLs in [any other text-based format...](https://github.com/ArchiveBox/ArchiveBox/wiki/Usage#Import-a-list-of-URLs-from-a-text-file)
+ ArchiveBox supports injecting URLs in [any other text-based format...](https://github.com/ArchiveBox/ArchiveBox/wiki/Usage#Import-a-list-of-URLs-from-a-text-file)
+
+-
Exported [browser history](https://github.com/ArchiveBox/ArchiveBox/wiki/Quickstart#2-get-your-list-of-urls-to-archive) or [browser bookmarks](https://github.com/ArchiveBox/ArchiveBox/wiki/Quickstart#2-get-your-list-of-urls-to-archive) from any browser
+ See instructions for: Chrome, Firefox, Safari, IE, Opera, and more...
+
+-
Links exported from bookmarking services or social media sites (e.g. Twitter bookmarks, Reddit saved posts, etc.)
+ See instructions for: Pocket, Pinboard, Instapaper, Shaarli, Delicious, Reddit Saved, Wallabag, Unmark.it, OneTab, Firefox Sync, and more...
-
[MITM Proxy](https://mitmproxy.org/) archiving with [`archivebox-proxy`](https://github.com/ArchiveBox/archivebox-proxy)
- Provides [realtime archiving](https://github.com/ArchiveBox/ArchiveBox/issues/577) of all traffic from any device going through the proxy.
-
--
Exported [browser history](https://github.com/ArchiveBox/ArchiveBox/wiki/Quickstart#2-get-your-list-of-urls-to-archive) or [browser bookmarks](https://github.com/ArchiveBox/ArchiveBox/wiki/Quickstart#2-get-your-list-of-urls-to-archive)
- See instructions for: Chrome, Firefox, Safari, IE, Opera, and more...
-
--
Links exported from Bookmarks on social media sites or Brookmarking services
- See instructions for: Pocket, Pinboard, Instapaper, Shaarli, Delicious, Reddit Saved, Wallabag, Unmark.it, OneTab, Firefox Sync, and more...
-
+ Provides [realtime archiving](https://github.com/ArchiveBox/ArchiveBox/issues/577) of all traffic from any device going through the proxy.