Skip to content

Commit b3cf92f

Browse files
committed
Updated ReadMe to reference v1. Added example to help with issue #2
1 parent 203e12d commit b3cf92f

File tree

1 file changed

+15
-5
lines changed

1 file changed

+15
-5
lines changed

Readme.md

Lines changed: 15 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,11 @@ This PowerShell module provides a series of cmdlets for interacting with the [Se
66

77
**IMPORTANT:** Neither this module nor its creator are in any way affiliated with ServiceNow.
88

9-
## Version 2 Overview
9+
## Version 1
1010

11-
The module has been renamed from PSServiceNow to ServiceNow for version 2. This change moves us away from the reserved "PS" prefix. In addition to the name change the following high level changes have been made:
11+
The module has been renamed from PSServiceNow to ServiceNow for version 1. This change moves us away from the reserved "PS" prefix. Since the name change is a major change for the user base and the project was never incremented to v1 we've taken the opportunity to label it such.
12+
13+
In addition to the name change the following high level changes have been made:
1214

1315
Back End:
1416

@@ -17,14 +19,14 @@ Back End:
1719
* Pester testing has been expanded to cover more scenarios.
1820
* Improved code formatting, removed aliases, fixed file encoding.
1921

20-
The gains are marginal in some aspects, but may allow for better management in the future including setting the stage for the ability to use AppVeyor & PSDeploy.
22+
The gains are marginal in some aspects, but intended to allow for better management in the future.
2123

2224
Front End:
2325

2426
* The following fields are now returned in the DateTime format instead of string: 'closed_at','expected_start','follow_up','opened_at','sys_created_on','sys_updated_on','work_end','work_start'
2527
* The formatting of returned data has been updated across all the `Get` functions except `Get-ServiceNowTable`. This means you'll see a handful of default properties returned and can use `Format-List` or `Select-Object` to view all other properties associated with the object.
2628

27-
Thse changes should improve your ability to filter on the right, especially by DateTime, as well as return more information in general.
29+
These changes should improve your ability to filter on the right, especially by DateTime, as well as return more information in general.
2830

2931
## Requirements
3032

@@ -36,6 +38,14 @@ Download the [latest release](https://github.com/Sam-Martin/servicenow-powershel
3638
`Import-Module ServiceNow`
3739
Once you've done this, all the cmdlets will be at your disposal, you can see a full list using `Get-Command -Module ServiceNow`.
3840

41+
### Example - Using Set-ServiceNowAuth
42+
43+
```PowerShell
44+
Set-ServiceNowAuth -url InstanceName -Credentials (Get-Credential)
45+
```
46+
47+
The URL should be the instance name portion of the FQDN for your instance. For if you browse to `myinstance.service-now.com` the URL required for the module is `myinstance`.
48+
3949
### Example - Retrieving an Incident Containing the Word 'PowerShell'
4050

4151
```PowerShell
@@ -93,4 +103,4 @@ This module has been created as an abstraction layer to suit my immediate requir
93103

94104
## Author
95105

96-
Author:: Sam Martin (<samjackmartin@gmail.com>)
106+
Author:: Sam Martin (<samjackmartin@gmail.com>)

0 commit comments

Comments
 (0)