Skip to content

Commit

Permalink
Add badges (#24)
Browse files Browse the repository at this point in the history
  • Loading branch information
ThomasNieto committed Aug 1, 2023
1 parent 7080196 commit b663689
Show file tree
Hide file tree
Showing 2 changed files with 33 additions and 9 deletions.
File renamed without changes.
42 changes: 33 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,58 +1,82 @@
# AnyPackage.Chocolatey
AnyPackage.Chocolatey is an AnyPackage provider that facilitates installing Chocolatey packages from any NuGet repository.

[![gallery-image]][gallery-site]
[![build-image]][build-site]
[![cf-image]][cf-site]

[gallery-image]: https://img.shields.io/powershellgallery/dt/AnyPackage.Chocolatey
[build-image]: https://img.shields.io/github/actions/workflow/status/anypackage/chocolatey/ci.yml
[cf-image]: https://img.shields.io/codefactor/grade/github/anypackage/chocolatey
[gallery-site]: https://www.powershellgallery.com/packages/AnyPackage.Chocolatey
[build-site]: https://github.com/anypackage/chocolatey/actions/workflows/ci.yml
[cf-site]: https://www.codefactor.io/repository/github/anypackage/chocolatey

`AnyPackage.Chocolatey` is an AnyPackage provider that facilitates installing Chocolatey packages from any NuGet repository.

## Install AnyPackage.Chocolatey
```PowerShell

```powerShell
Install-Module AnyPackage.Chocolatey -Force
```

## Import AnyPackage.Chocolatey
```PowerShell

```powerShell
Import-Module AnyPackage.Chocolatey
```

## Sample usages

### Search for a package
```PowerShell

```powerShell
Find-Package -Name nodejs
Find-Package -Name firefox*
```

### Install a package
```PowerShell

```powerShell
Find-Package nodejs | Install-Package
Install-Package -Name 7zip
```

### Get list of installed packages
```PowerShell

```powerShell
Get-Package nodejs
```

### Uninstall a package
```PowerShell

```powerShell
Get-Package keepass-plugin-winhello | Uninstall-Package
```

### Manage package sources
```PowerShell

```powerShell
Register-PackageSource privateRepo -Provider Chocolatey -Location 'https://somewhere/out/there/api/v2/'
Find-Package nodejs -Source privateRepo | Install-Package
Unregister-PackageSource privateRepo
```

AnyPackage.Chocolatey integrates with Choco.exe to manage and store source information

## Known Issues

### Compatibility

AnyPackage.Chocolatey works with PowerShell for both FullCLR/'Desktop' (ex 5.1) and CoreCLR (ex: 7.0.1), though Chocolatey itself still requires FullCLR.

Users must upgrade to v0.1.0 or higher of this provider module prior to the release of Chocolatey v2 to ensure continued compatibility.

### Save a package

Save-Package is not supported with the AnyPackage.Chocolatey provider, due to Chocolatey not supporting package downloads without special licensing.

## Legal and Licensing
AnyPackage.Chocolatey is licensed under the [MIT license](./LICENSE.txt).

AnyPackage.Chocolatey is licensed under the [MIT license](./LICENSE).

0 comments on commit b663689

Please sign in to comment.