diff --git a/README.md b/README.md index 3078b75..9cd5784 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,9 @@ # pad-archiver -Archives your pad +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: + +``` +include: + - project: '/fginfo/pad-archiver' + file: 'lib/gitlab-ci.yml' +```