Skip to content

Commit

Permalink
docs: Who doesn't need badges
Browse files Browse the repository at this point in the history
  • Loading branch information
svrooij committed May 1, 2024
1 parent 0350b5d commit c2cc040
Show file tree
Hide file tree
Showing 2 changed files with 32 additions and 10 deletions.
23 changes: 21 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
# WinTuner

[![Documentation badge](https://img.shields.io/badge/Read-Documentation-green?style=for-the-badge)](https://wintuner.app/)
[![Documentation badge](https://img.shields.io/badge/Show_Documentation-darkblue?style=for-the-badge)](https://wintuner.app/)
[![PowerShell gallery version][badge_powershell]][link_powershell]
[![Nuget version][badge_nuget]][link_nuget]
[![License][badge_license]][link_license]
[![GitHub issues](https://img.shields.io/github/issues/svrooij/wingetintune?style=for-the-badge)](https://github.com/svrooij/WingetIntune/issues)
[![Github sponsors](https://img.shields.io/github/sponsors/svrooij?style=for-the-badge&logo=github&logoColor=white)](https://github.com/sponsors/svrooij)

Expand All @@ -20,6 +23,9 @@ Take any app from WinGet and upload it to Intune in minutes. This app is availab

## WinTuner PowerShell Module

[![PowerShell gallery version][badge_powershell]][link_powershell]
[![PowerShell gallery downloads][badge_powershell_downloads]][link_powershell]

This is the PowerShell version of the WinTuner application, requiring PowerShell `7.4` (net8.0). Available in the [PowerShell Gallery](https://www.powershellgallery.com/packages/WinTuner/). Documentation can be found [here](https://wintuner.app/docs/category/wintuner-powershell).

```PowerShell
Expand All @@ -30,6 +36,9 @@ As of April 2024, the main development focus will be on the PowerShell module, s

## WinTuner CLI

[![Nuget version][badge_nuget]][link_nuget]
[![Nuget downloads][badge_nuget_downloads]][link_nuget]

This application requires **Dotnet 8** to be installed on your computer. It's a [beta application](#beta-application), so please report any issues you find.
Some commands run the `winget` in the background and are thus Windows-only, make sure you have the [App Installer](https://www.microsoft.com/p/app-installer/9nblggh4nns1) installed on your computer if you want to use these commands.

Expand Down Expand Up @@ -61,4 +70,14 @@ If you want to contribute to this project, please check out the [contributing](h
[link_blog]: https://svrooij.io/
[link_linkedin]: https://www.linkedin.com/in/stephanvanrooij
[link_mastodon]: https://dotnet.social/@svrooij
[link_twitter]: https://twitter.com/svrooij
[link_twitter]: https://twitter.com/svrooij

[badge_license]: https://img.shields.io/github/license/svrooij/WingetIntune?style=for-the-badge
[link_license]: https://github.com/svrooij/WingetIntune/blob/main/LICENSE.txt
[badge_powershell]: https://img.shields.io/powershellgallery/v/WinTuner?style=for-the-badge&logo=powershell&logoColor=white
[badge_powershell_downloads]: https://img.shields.io/powershellgallery/dt/WinTuner?style=for-the-badge&logo=powershell&logoColor=white
[link_powershell]: https://www.powershellgallery.com/packages/WinTuner/

[badge_nuget]: https://img.shields.io/nuget/v/Svrooij.Winget-Intune.Cli?style=for-the-badge&logo=nuget&logoColor=white
[badge_nuget_downloads]: https://img.shields.io/nuget/dt/Svrooij.Winget-Intune.Cli?style=for-the-badge&logo=nuget&logoColor=white
[link_nuget]: https://www.nuget.org/packages/Svrooij.Winget-Intune.Cli/
19 changes: 11 additions & 8 deletions src/Svrooij.WinTuner.CmdLets/README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,16 @@
# WinTuner PowerShell module

## Refresh documentation
[![Documentation badge](https://img.shields.io/badge/Show_Documentation-darkblue?style=for-the-badge)](https://wintuner.app/)
[![PowerShell gallery version][badge_powershell]][link_powershell]
[![PowerShell gallery downloads][badge_powershell_downloads]][link_powershell]
[![License][badge_license]][link_license]

```PowerShell
New-MarkdownHelp -Module "Svrooij.WinTuner.CmdLets" -OutputFolder "..\..\..\docs" -WithModulePage -Force
```
Source of WinTuner PowerShell module, available in the [PowerShell Gallery][link_powershell].

## Create a package and deploy to Intune
Documentation can be found [here](https://wintuner.app/docs/category/wintuner-powershell).

```PowerShell
New-WtWingetPackage -PackageId Jandedobbeleer.ohmyposh -PackageFolder C:\tools\packages\ | Deploy-WtWin32App -Username [email protected]
```
[badge_license]: https://img.shields.io/github/license/svrooij/WingetIntune?style=for-the-badge
[link_license]: https://github.com/svrooij/WingetIntune/blob/main/LICENSE.txt
[badge_powershell]: https://img.shields.io/powershellgallery/v/WinTuner?style=for-the-badge&logo=powershell&logoColor=white
[badge_powershell_downloads]: https://img.shields.io/powershellgallery/dt/WinTuner?style=for-the-badge&logo=powershell&logoColor=white
[link_powershell]: https://www.powershellgallery.com/packages/WinTuner/

0 comments on commit c2cc040

Please sign in to comment.