@servicenow/sdk 1.0.2 → 1.0.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +25 -12
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -1,24 +1,37 @@
1
- # @servicenow/sdk
1
+ # ServiceNow SDK
2
2
 
3
- The Servicenow SDK!
3
+ Use the ServiceNow software development kit (SDK) to add JavaScript modules and third-party libraries to applications locally and upload changes to an instance of the Now Platform.
4
4
 
5
- ## Pre-requisites
5
+ # Overview
6
6
 
7
- * Node.js v16
8
- * npm v8
7
+ With the ServiceNow SDK, developers can create and modify scoped applications with custom modules and third-party libraries in Visual Studio Code and deploy those applications to a non-production instance on the Washington DC release. Writing ServiceNow applications outside of a ServiceNow instance enables you to use industry-standard development practices and familiar tools and catch errors at build-time rather than at run-time only.
8
+
9
+ For more information see the [SDK Overview documentation](https://docs.servicenow.com/bundle/washingtondc-api-reference/page/script/sdk/concept/servicenow-sdk.html) or the [CLI Overview](https://docs.servicenow.com/bundle/washingtondc-api-reference/page/script/sdk/reference/servicenow-sdk-cli-commands.html)
9
10
 
10
11
  ## Installation
11
12
 
12
- ```bash
13
- npm install --global @servicenow/sdk
14
- ```
13
+ Install the ServiceNow software development kit (SDK) locally using Node Package Manager (npm).
14
+
15
+ ### Before you begin
15
16
 
16
- ## Usage
17
+ Your system must meet the following requirements to use npm to install the SDK:
18
+ * Node.js v16 or later
19
+ * npm v8 or later
17
20
 
18
- ### Command list
21
+ To install or upgrade Node.js or npm, see the [installation instructions](https://docs.npmjs.com/cli/v8/configuring-npm/install) on the npm website.
19
22
 
23
+ ### Procedure
24
+
25
+ 1. Open a command-line tool on your system.
26
+ 2. Verify that your system meets the requirements.
27
+ a. Enter `node –v`​ to check if you have Node.js installed and which version.
28
+ b. Enter `npm –v`​ to check if you have npm installed and which version.
29
+ 3. Enter the following command to install the SDK:
20
30
  ```bash
21
- now-sdk --help
31
+ npm install --global @servicenow/sdk
22
32
  ```
23
33
 
24
- Refer to [ServiceNow ](https://docs.servicenow.com/bundle/washingtondc-api-reference/page/script/sdk/reference/servicenow-sdk-cli-commands.html) docs for more information
34
+ ## What to do next
35
+
36
+ Use the ServiceNow SDK to create a scoped application or convert an existing application for use with the SDK. For more information, see [Create or convert an application with the ServiceNow SDK](https://docs.servicenow.com/bundle/washingtondc-api-reference/page/script/sdk/task/create-application-now-sdk.html).
37
+
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@servicenow/sdk",
3
- "version": "1.0.2",
3
+ "version": "1.0.3",
4
4
  "description": "ServiceNow SDK CLI",
5
5
  "license": "MIT",
6
6
  "bin": {