Skip to content

Commit 80a0f2a

Browse files
committed
Update README.md
1 parent 1d79ca2 commit 80a0f2a

File tree

1 file changed

+34
-19
lines changed

1 file changed

+34
-19
lines changed

README.md

Lines changed: 34 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,31 @@
11
# ![PSAppDeployToolkit.Tools](https://github.com/user-attachments/assets/a275b3f9-6a45-42f0-a377-a57036d3f84d)
22

3-
## Enterprise App Packaging, Extended.
3+
## 🚀 Enterprise App Packaging, Extended
44

55
PSAppDeployToolkit.Tools is a companion module for [PSAppDeployToolkit](https://github.com/PSAppDeployToolkit/PSAppDeployToolkit) that provides tools and functions useful during the application packaging process. Having this separate allows for a separate release schedule and also reduces the file size of the module that is required to be delivered to endpoints to handle software deployments.
66

7-
### Features
7+
### ✨ Key Features
88

9-
- **Test-ADTCompatibility** - Test your PSAppDeployToolkit v3 scripts to get a full report on which functions and variables have changed in v4.
10-
- **Convert-ADTDeployment** - Convert a PSAppDeployToolkit v3 script or an entire package folder to v4 standards.
9+
- **Test-ADTCompatibility** - Test your PSAppDeployToolkit v3 scripts to get a full report on which functions and variables have changed in v4.1.
10+
- **Convert-ADTDeployment** - Convert a PSAppDeployToolkit v3 script or an entire package folder to v4.1 standards.
1111

12-
## Getting Started
12+
## 🚀 Getting Started
13+
14+
### Prerequisites
15+
16+
- Windows 10/11
17+
- PowerShell 5.1 or later
18+
- .NET Framework 4.7.2 or later
19+
20+
### Installing The Module
1321

1422
Install the module from the PowerShell Gallery:
1523

1624
```powershell
1725
Install-Module PSAppDeployToolkit.Tools -Scope CurrentUser -AllowPreRelease
1826
```
1927

20-
If this produces an error that the `-AllowPreRelease` parameter is not recognised, then first update PowerShellGet and then restart your PowerShell console:
28+
If this produces an error that the `-AllowPreRelease` parameter is not recognized, then first update PowerShellGet and then restart your PowerShell console:
2129

2230
```powershell
2331
Install-Module PowerShellGet -Force -Scope CurrentUser
@@ -49,22 +57,29 @@ Convert-ADTDeployment -Path .\PackageFolder
4957

5058
This example converts PackageFolder into PackageFolder_Converted in the same folder.
5159

52-
### PSAppDeployToolkit Links
60+
## 📄 License
61+
62+
This project is licensed under the [GNU Lesser General Public License](https://github.com/PSAppDeployToolkit/PSAppDeployToolkit/blob/main/COPYING.Lesser)
63+
64+
## Important Links
5365

54-
-> [Homepage](https://psappdeploytoolkit.com)
55-
-> [Documentation](https://psappdeploytoolkit.com/docs)
56-
-> [Function & Variable References](https://psappdeploytoolkit.com/docs/reference)
57-
-> [Download Latest Release](https://github.com/PSAppDeployToolkit/PSAppDeployToolkit/releases)
58-
-> [News](https://psappdeploytoolkit.com/blog)
66+
### PSAppDeployToolkit
5967

60-
### Community Links
68+
- [Homepage](https://psappdeploytoolkit.com)
69+
- [Latest News](https://psappdeploytoolkit.com/blog)
70+
- [Documentation](https://psappdeploytoolkit.com/docs/introduction)
71+
- [Function & Variable References](https://psappdeploytoolkit.com/docs/reference)
72+
- [PowerShell Gallery](https://www.powershellgallery.com/packages/PSAppDeployToolkit)
73+
- [GitHub Releases](https://github.com/PSAppDeployToolkit/PSAppDeployToolkit/releases)
6174

62-
-> [Discourse Forum](https://discourse.psappdeploytoolkit.com/)
63-
-> [Discord Chat](https://discord.com/channels/618712310185197588/627204361545842688)
64-
-> [Reddit](https://reddit.com/r/psadt)
75+
### Community
6576

66-
## License
77+
- [Discourse Forum](https://discourse.psappdeploytoolkit.com/)
78+
- [Discord Chat](https://discord.com/channels/618712310185197588/627204361545842688)
79+
- [Reddit](https://reddit.com/r/psadt)
6780

68-
The PowerShell App Deployment Tool is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation, either version 3 of the License, or any later version.
81+
### GitHub
6982

70-
This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.
83+
- [Issues](https://github.com/PSAppDeployToolkit/PSAppDeployToolkit/issues)
84+
- [Security Policy](https://github.com/PSAppDeployToolkit/PSAppDeployToolkit/security)
85+
- [Contributor Guidelines](https://github.com/PSAppDeployToolkit/PSAppDeployToolkit/blob/main/.github/CONTRIBUTING.md)

0 commit comments

Comments
 (0)