diff --git a/README.md b/README.md index 5c0335c7..179fd117 100644 --- a/README.md +++ b/README.md @@ -82,17 +82,11 @@ Using multiple methods and the market-dominant browser to execute JS ensures we - `git/` clone of any repository for github, bitbucket, or gitlab links - `index.html` & `index.json` HTML and JSON index files containing metadata and details +By default it does everything, but can disable or tweak individual options via environment variables or config file. + The archiving is additive, so you can schedule `./archive` to run regularly and pull new links into the index. All the saved content is static and indexed with JSON files, so it lives forever & is easily parseable, it requires no always-running backend. -**Next Steps:** - - - Read [[Configuration]] to learn about the various archive method options - - Read [[Scheduled Archiving]] to learn how to set up automatic daily archiving - - Read [[Publishing Your Archive]] if you want to host your archive for others to access online - - Read [[Troubleshooting]] if you encounter any problems - - # Documentation