Skip to content
This repository has been archived by the owner on Apr 22, 2023. It is now read-only.

Commit

Permalink
💎 Release v0.0.4
Browse files Browse the repository at this point in the history
  • Loading branch information
MeneDev committed Sep 14, 2018
1 parent ffa8822 commit 505f47c
Showing 1 changed file with 96 additions and 7 deletions.
103 changes: 96 additions & 7 deletions README.adoc
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@

:branch: develop
:branch: master

== dockmoor
image:https://img.shields.io/circleci/project/github/MeneDev/dockmoor/{branch}.svg[Build Status (Circle CI), link=https://circleci.com/gh/MeneDev/dockmoor]
Expand All @@ -13,7 +13,7 @@ Manage docker image references.
Examples
--------
[[contains-command-examples]]
[[list-command-examples]]
list command
~~~~~~~~~~~~
Expand Down Expand Up @@ -183,8 +183,8 @@ stdout:
_____________________________________________
....
some-folder/Dockerfile-nginx-latest
some-folder/subfolder/Dockerfile-nginx-latest
some-folder/Dockerfile-nginx-untagged
some-folder/subfolder/Dockerfile-nginx-latest
some-folder/Dockerfile-nginx-1.15.3
....
_____________________________________________
Expand All @@ -206,8 +206,8 @@ stdout:
_____________________________________________
....
some-folder/Dockerfile-nginx-latest
some-folder/subfolder/Dockerfile-nginx-latest
some-folder/Dockerfile-nginx-untagged
some-folder/subfolder/Dockerfile-nginx-latest
....
_____________________________________________
Expand All @@ -228,10 +228,10 @@ stdout:
_____________________________________________
....
some-folder/Dockerfile-nginx-digest
some-folder/Dockerfile-nginx-tagged-digest
some-folder/Dockerfile-nginx-latest
some-folder/subfolder/Dockerfile-nginx-latest
some-folder/Dockerfile-nginx-tagged-digest
some-folder/Dockerfile-nginx-untagged
some-folder/subfolder/Dockerfile-nginx-latest
some-folder/Dockerfile-nginx-1.15.3
....
_____________________________________________
Expand Down Expand Up @@ -269,5 +269,94 @@ Supported Formats

* Dockerfile (as used by `docker build`)

Unresolved directive in _readme.adoc - include::dockmoor.adoc[]
[[_usage]]
Usage
-----
__________________________________________________________________________________________________
dockmoor [OPTIONS] <link:#contains-command[contains] | link:#list-command[list]> [command-OPTIONS]
__________________________________________________________________________________________________
[[_application_options]]
Application Options
-------------------

**-l**, *--log-level* Sets the log-level (one of `NONE`, `ERROR`, `WARN`, `INFO`, `DEBUG`)

*--version* Show version and exit

*--manpage* Show man page and exit

*--markdown* Show usage as markdown and exit

*--asciidoc-usage* Show usage as asciidoc and exit

[[_help_options]]
Help Options
------------
**-h**, *--help* Show this help message
[[_commands]]
Commands
~~~~~~~~
* link:#contains-command[contains]
* link:#list-command[list]
[[_contains_command]]
contains command
^^^^^^^^^^^^^^^^
________________________________________________________
dockmoor [OPTIONS] contains [contains-OPTIONS] InputFile
________________________________________________________
Returns exit code 0 when the given input contains at least one image reference that satisfy the given conditions, non-null otherwise
[[_predicates]]
Predicates
~~~~~~~~~~
Specify which kind of image references should be selected. Exactly one must be specified
*--any* Matches all images
*--latest* Matches images with latest or no tag
*--unpinned* Matches unpinned images
[[_help_options_2]]
Help Options
~~~~~~~~~~~~
**-h**, *--help* Show this help message
[[_list_command]]
list command
^^^^^^^^^^^^
________________________________________________
dockmoor [OPTIONS] list [list-OPTIONS] InputFile
________________________________________________
Returns exit code 0 when the given input contains at least one image reference that satisfy the given conditions, non-null otherwise
[[_predicates_2]]
Predicates
~~~~~~~~~~
Specify which kind of image references should be selected. Exactly one must be specified
*--any* Matches all images
*--latest* Matches images with latest or no tag
*--unpinned* Matches unpinned images
[[_help_options_3]]
Help Options
~~~~~~~~~~~~
**-h**, *--help* Show this help message

0 comments on commit 505f47c

Please sign in to comment.