From 95bb61cb7397deec9939f50c9cb3e04b55f267af Mon Sep 17 00:00:00 2001 From: Tim Schubert Date: Tue, 26 Apr 2022 20:33:11 +0000 Subject: [PATCH] Update README.md --- README.md | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index def1638..e733bea 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,17 @@ # pad-archiver -Archives your pad. Use in your project that contains `pads.txt`, containing a list of URLs (one per line) with `.gitlab-ci.yml` like so: +Archives the list of URLs provided on the standard input. +```shell +update < pads.txt ``` + +The CI-config in `lib/gitlab-ci.yml` can be used in your project by including the following at the top of your project's `.gitlab-ci.yml`. + +```yaml include: - project: 'fginfo/pad-archiver' file: 'lib/gitlab-ci.yml' ``` -The project including the CI configuration has to provide the variable `CI_ACCESS_TOKEN`. It must contain a project access token that can push to the repo. +The project including the CI configuration has to provide the variable `CI_ACCESS_TOKEN`. The variable must contain a project access token that can push to commits to your project.