From 2fb77124de4a821cbd55868e72976482233b85bf Mon Sep 17 00:00:00 2001 From: Thomas Nieto <38873752+ThomasNieto@users.noreply.github.com> Date: Mon, 12 May 2025 23:40:51 -0500 Subject: [PATCH] Update readme --- .cspell.jsonc | 1 + README.md | 47 ++++++++++++++++++++++++++++++++++++++++++++++- 2 files changed, 47 insertions(+), 1 deletion(-) diff --git a/.cspell.jsonc b/.cspell.jsonc index a381d53..a9c2eb7 100644 --- a/.cspell.jsonc +++ b/.cspell.jsonc @@ -2,6 +2,7 @@ "words": [ "anypackage", "Authenticode", + "justingrote", "LASTEXITCODE", "Nieto", "SARIF", diff --git a/README.md b/README.md index 1f99870..78c7505 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,48 @@ # AnyPackage.Docker -Docker provider for AnyPackage. +[![gallery-image]][gallery-site] +[![build-image]][build-site] +[![cf-image]][cf-site] + +[gallery-image]: https://img.shields.io/powershellgallery/dt/AnyPackage.Docker +[build-image]: https://img.shields.io/github/actions/workflow/status/anypackage/docker/ci.yml +[cf-image]: https://img.shields.io/codefactor/grade/github/anypackage/docker +[gallery-site]: https://www.powershellgallery.com/packages/AnyPackage.Docker +[build-site]: https://github.com/anypackage/docker/actions/workflows/ci.yml +[cf-site]: https://www.codefactor.io/repository/github/anypackage/docker + +`AnyPackage.Docker` is an AnyPackage provider that facilitates managing Docker +apps. + +## Install AnyPackage.Docker + +```powershell +Install-PSResource AnyPackage +Install-PSResource AnyPackage.Docker -SkipDependencyCheck +``` + +## Import AnyPackage.Docker + +```powershell +Import-Module AnyPackage.Docker +``` + +## Sample usages + +### Get list of installed images + +```powershell +Get-Package -Name nginx +``` + +### Install image + +```powershell +Install-Package -Name justingrote/powershell -Version latest -Source ghcr.io +``` + +### Uninstall image + +```powershell +Uninstall-Package -Name nginx +```