powershell.README.mustache Maven / Gradle / Ivy

Go to download
# {{packageName}} - the PowerShell module for the {{appName}}

{{#appDescriptionWithNewLines}}
{{{appDescriptionWithNewLines}}}
{{/appDescriptionWithNewLines}}

This PowerShell module is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:

- API version: {{appVersion}}
- SDK version: {{packageVersion}}
{{^hideGenerationTimestamp}}
- Build date: {{generatedDate}}
{{/hideGenerationTimestamp}}
- Build package: {{generatorClass}}
{{#infoUrl}}
    For more information, please visit [{{{infoUrl}}}]({{{infoUrl}}})
{{/infoUrl}}


## Frameworks supported
- PowerShell 3.0 or later


## Dependencies
- C# API client generated by OpenAPI Generator AND should be located in {{{csharpClientPath}}} as stated in Build.ps1


## Installation
Run the following command to generate the DLL
- [Windows] `Build.ps1`

Then import module from the .\src\{{{packageName}}} folder:
```powershell
using {{packageName}}.{{apiPackage}};
using {{packageName}}.Client;
using {{packageName}}.{{modelPackage}};
```