diff --git a/.github/workflows/homebrew.yml b/.github/workflows/homebrew.yml index 79ecf6e8..70ce8ded 100644 --- a/.github/workflows/homebrew.yml +++ b/.github/workflows/homebrew.yml @@ -101,6 +101,19 @@ ${RESOURCES} system bin/"archivebox", "init" end + def caveats + <<~EOS + ArchiveBox data is stored in: + #{var}/archivebox + + To start archiving, run: + cd #{var}/archivebox && archivebox add 'https://example.com' + + To start the web UI: + cd #{var}/archivebox && archivebox server 0.0.0.0:8000 + EOS + end + test do assert_match version.to_s, shell_output("#{bin}/archivebox version") end diff --git a/bin/build_brew.sh b/bin/build_brew.sh index d94b13ca..80d4aa11 100755 --- a/bin/build_brew.sh +++ b/bin/build_brew.sh @@ -88,6 +88,19 @@ ${RESOURCES} system bin/"archivebox", "init" end + def caveats + <<~EOS + ArchiveBox data is stored in: + #{var}/archivebox + + To start archiving, run: + cd #{var}/archivebox && archivebox add 'https://example.com' + + To start the web UI: + cd #{var}/archivebox && archivebox server 0.0.0.0:8000 + EOS + end + test do assert_match version.to_s, shell_output("#{bin}/archivebox version") end diff --git a/brew_dist/archivebox.rb b/brew_dist/archivebox.rb index 5eb56de8..3e4d2f31 100644 --- a/brew_dist/archivebox.rb +++ b/brew_dist/archivebox.rb @@ -31,6 +31,19 @@ class Archivebox < Formula system bin/"archivebox", "init" end + def caveats + <<~EOS + ArchiveBox data is stored in: + #{var}/archivebox + + To start archiving, run: + cd #{var}/archivebox && archivebox add 'https://example.com' + + To start the web UI: + cd #{var}/archivebox && archivebox server 0.0.0.0:8000 + EOS + end + test do assert_match version.to_s, shell_output("#{bin}/archivebox version") end