Skip to content

Commit 7a51698

Browse files
committed
docs: Updated documentation
1 parent a560ef0 commit 7a51698

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,17 @@
11
# confluence-outdated - Constant validation of Confluence document outdates
22

3-
[![Build Status](https://travis-ci.org/dodevops/confluence-outdated.svg?branch=master)](https://travis-ci.org/dodevops/confluence-outdated) ![npm](https://img.shields.io/npm/v/confluence-outdated)
3+
[![Docker](https://github.com/dodevops/confluence-outdated/actions/workflows/docker-publish.yml/badge.svg)](https://github.com/dodevops/confluence-outdated/actions/workflows/docker-publish.yml)
44

55
## Introduction
66

77
_confluence-outdated_ searches a Confluence space for documents that haven't been updated for a specified time and
88
notifies the author of the last version of each document or a separate page maintainer.
99

10-
## Installation
10+
## Usage
1111

12-
Install _confluence-outdated_ globally running
12+
_confluence-outdated_ can be used with Docker to quickly run it without any further dependencies.
1313

14-
npm install -g confluence-outdated
14+
docker run --rm -it ghcr.io/dodevops/confluence-outdated:main <arguments>
1515

1616
## Configuration Document
1717

@@ -21,7 +21,7 @@ _confluence-outdated_ reads its configuration from a Confluence document.
2121
The structure of this document is based on Panels and tables. To ease the creation of this document,
2222
_confluence-outdated_ includes a command to create a template document:
2323

24-
confluence-outdated createconfigurationdocument --url <Confluence base URL> --user <Username> --password <Password> --space <Key of space that should hold the document> --title <Title for the configuration document> --parentId <Page ID that the configuration document is place under>
24+
confluence-outdated CreateConfigurationDocument --url <Confluence base URL> --user <Username> --password <Password> --space <Key of space that should hold the document> --title <Title for the configuration document> --parentId <Page ID that the configuration document is place under>
2525

2626
Example:
2727

0 commit comments

Comments
 (0)