Update README.md
This commit is contained in:
parent
9a9ef67a06
commit
95bb61cb73
1 changed files with 8 additions and 2 deletions
10
README.md
10
README.md
|
@ -1,11 +1,17 @@
|
||||||
# pad-archiver
|
# 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:
|
include:
|
||||||
- project: 'fginfo/pad-archiver'
|
- project: 'fginfo/pad-archiver'
|
||||||
file: 'lib/gitlab-ci.yml'
|
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.
|
||||||
|
|
Loading…
Add table
Add a link
Reference in a new issue