Skip to content

Commit 23e6a9c

Browse files
authored
Update readme (#7)
1 parent 43a2492 commit 23e6a9c

File tree

2 files changed

+47
-1
lines changed

2 files changed

+47
-1
lines changed

.cspell.jsonc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
"words": [
33
"anypackage",
44
"Authenticode",
5+
"justingrote",
56
"LASTEXITCODE",
67
"Nieto",
78
"SARIF",

README.md

Lines changed: 46 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,48 @@
11
# AnyPackage.Docker
22

3-
Docker provider for AnyPackage.
3+
[![gallery-image]][gallery-site]
4+
[![build-image]][build-site]
5+
[![cf-image]][cf-site]
6+
7+
[gallery-image]: https://img.shields.io/powershellgallery/dt/AnyPackage.Docker
8+
[build-image]: https://img.shields.io/github/actions/workflow/status/anypackage/docker/ci.yml
9+
[cf-image]: https://img.shields.io/codefactor/grade/github/anypackage/docker
10+
[gallery-site]: https://www.powershellgallery.com/packages/AnyPackage.Docker
11+
[build-site]: https://github.com/anypackage/docker/actions/workflows/ci.yml
12+
[cf-site]: https://www.codefactor.io/repository/github/anypackage/docker
13+
14+
`AnyPackage.Docker` is an AnyPackage provider that facilitates managing Docker
15+
apps.
16+
17+
## Install AnyPackage.Docker
18+
19+
```powershell
20+
Install-PSResource AnyPackage
21+
Install-PSResource AnyPackage.Docker -SkipDependencyCheck
22+
```
23+
24+
## Import AnyPackage.Docker
25+
26+
```powershell
27+
Import-Module AnyPackage.Docker
28+
```
29+
30+
## Sample usages
31+
32+
### Get list of installed images
33+
34+
```powershell
35+
Get-Package -Name nginx
36+
```
37+
38+
### Install image
39+
40+
```powershell
41+
Install-Package -Name justingrote/powershell -Version latest -Source ghcr.io
42+
```
43+
44+
### Uninstall image
45+
46+
```powershell
47+
Uninstall-Package -Name nginx
48+
```

0 commit comments

Comments
 (0)