Merge pull request #28 from Readify/readme

Added README.md [skip ci]

README.md

@@ -1 +1,137 @@
-PwshZendesk
+# PwshZendesk
+
+![Build Status]
+
+PwshZendesk is a Zendesk Support API client for Powershell.
+PwshZendesk supports Powershell versions 5.0, 5.1, 6, and 7 on all platforms.
+
+
+## Getting Started
+
+These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.
+
+### Prerequisites
+
+PwshZendesk naturally requires a functioning Powershell environment.
+Official documentation on installing Powershell can be found
+[here.](https://docs.microsoft.com/en-us/powershell/scripting/install/installing-powershell)
+
+You will also need a Zendesk API Token.
+You can generate an API Token from the admin area of the Support portal.
+Head to Admin => Channels => API and click the `+` under "Token Access"
+
+### Installing
+
+PwshZendesk supports Powershell versions 5.0, 5.1, 6, and 7 on all platforms.
+
+It is recommended to install PwshZendesk from the [PowerShell Gallery]:
+
+```Powershell
+Install-Module -Name 'PwshZendesk'
+```
+
+PwshZendesk is ready to go after a git clone or by downloading and extracting one of the [releases].
+
+Microsoft has some official documentation on [installing] and [importing] Powershell modules.
+
+### Quickstart
+
+The most basic operation you can perform with PwshZendesk is to retrieve the user object for the authenticated user.
+
+```Powershell
+# Read the Api Token. I must be a [SecureString]
+$token = Read-Host -Prompt 'Zendesk Api Token' -AsSecureString
+
+# Establish a connection to the Zendesk instance
+Connect-Zendesk -Organization 'organization' -Username '[email protected]' -ApiKey $token
+
+# Get the user record for the user we just connected as.
+Get-ZendeskAuthenticatedUser
+```
+
+## Running the tests
+
+PwshZendesk uses Style and Best Practice testing provided by [PSScriptAnalyzer] and Unit testing via the [Pester] framework
+
+### Style and Best Practice Testing
+
+Ensure you have [PSScriptAnalyzer] installed:
+
+```Powershell
+Install-Module -Name 'PSScriptAnalyzer'
+```
+
+And just run it over the `functions`, `internal`, and `tests` directories. The `PSScriptAnalyzerSettings.psd1` will get picked up and run all configured tests.
+I don't like the look of aligned assignments in the module manifest due to the large amounts of whitespace and comments, so it is excluded.
+
+```Powershell
+Get-ChildItem -Directory | Invoke-ScriptAnalyzer | Format-Table -AutoSize
+```
+
+### Unit tests
+
+Ensure you have [Pester] installed:
+
+```Powershell
+Install-Module -Name 'Pester'
+```
+
+And just run it from the project root in a non-interactive session.
+A non-interactive session is required so that tests ensuring certain parameters are required or parameter sets do not prompt the user for input.
+Tests that require a non-interactive session that are run interactively will automatically fail.
+
+```Powershell
+pwsh -NonInteractive -Command 'Invoke-Pester'
+```
+
+If you wish to skip tests that require an internet connection then you can run the following. The tests for the `Invoke-Method` function make use of calls to [httpstat.us] to test behavior when hitting api limits, and other http status code scenarios.
+
+```Powershell
+pwsh -NonInteractive -Command 'Invoke-Pester -ExcludeTag internet'
+```
+
+## Built With
+
+- [PSScriptAnalyzer] - Code Style and Best Practice testing
+- [Pester] - Testing framework
+- [httpstat.us] - Used to test getting different HTTP status codes back from the API
+- [GitVersion] - Used to calculate version.
+
+## Contributing
+
+Please read [CONTRIBUTING.md] for details on our code of conduct, and the process for submitting pull requests to us.
+
+## Versioning
+
+We use [SemVer] for versioning.
+For the versions available, see the [tags on this repository].
+
+We use [GitVersion] to calculate the version.
+
+## Authors
+
+- **Robert McLeod** - *Initial work* - [RobFaie](https://github.com/RobFaie)
+
+See also the list of [contributors] who participated in this project.
+
+## License
+
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details
+
+## Acknowledgments
+
+- **Billie Thompson** - *README.md template* - [PurpleBooth](https://github.com/PurpleBooth)
+
+
+[tags on this repository]: https://github.com/Readify/PwshZendesk/tags
+[CONTRIBUTING.md]: https://gist.github.com/PurpleBooth/b24679402957c63ec426
+[contributors]: https://github.com/Readify/PwshZendesk/contributors
+
+[PowerShell Gallery]: https://www.powershellgallery.com/packages/PwshZendesk
+[PSScriptAnalyzer]: https://github.com/PowerShell/PSScriptAnalyzer
+[Pester]: https://github.com/pester/Pester
+[GitVersion]: https://github.com/GitTools/GitVersion
+[httpstat.us]: https://httpstat.us
+[SemVer]: http://semver.org/
+
+[Build Status]: https://dev.azure.com/readify/Technology/_apis/build/status/Readify.PwshZendesk?branchName=master

tests/Invoke-Method.tests.ps1

@@ -3,7 +3,7 @@ Param()
 
 Import-Module "$PSScriptRoot/../PwshZendesk.psm1" -Force
 
-Describe 'Invoke-Method' {
+Describe 'Invoke-Method' -Tags 'internet' {
 
     InModuleScope PwshZendesk {