Skip to content

Commit e1485e9

Browse files
committed
Pull request #2: updating GH installation instructions now that this is on NPM
Merge in SDK/node_telesign_enterprise from PD-89704 to master * commit 'a7a21d3666aea1d9808ee92b23761a4901e91e1b': incrementing the version number to 3.0.1 updating GH installation instructions now that this is on NPM
2 parents 2642add + a7a21d3 commit e1485e9

File tree

2 files changed

+5
-21
lines changed

2 files changed

+5
-21
lines changed

README.md

Lines changed: 4 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -15,20 +15,7 @@
1515

1616
Follow these steps to add this SDK as a dependency to your project. Both the Telesign Full-service Node.js SDK and the Telesign Self-service Node.js SDK are installed because the Full-service SDK also uses some functionality in the Self-service SDK.
1717

18-
1. Create a new directory to download the Telesign SDK. This should not be in the same directory as where you build your integration.
19-
20-
```
21-
cd ~/code/local
22-
mkdir telesign_sdks
23-
cd telesign_sdks
24-
```
25-
26-
27-
2. Clone this repo. A new directory should appear called `node_telesign_enterprise`:
28-
29-
`git clone https://github.com/TeleSign/node_telesign_enterprise.git`
30-
31-
3. Create another directory (this must be outside of the SDK directory you just created) where you want to create your Telesign integration. Skip this step if you already have created a project. If you plan to create multiple Node.js projects that use Telesign, we recommend that you group them within a `telesign_integrations` directory.
18+
1. *(Optional)* Create a new directory for your Node.js project. Skip this step if you already have created a project. If you plan to create multiple Node.js projects that use Telesign, we recommend that you group them within a `telesign_integrations` directory.
3219

3320
```
3421
cd ~/code/local
@@ -38,14 +25,11 @@ Follow these steps to add this SDK as a dependency to your project. Both the Tel
3825
cd {your project name}
3926
```
4027

41-
4. Install the SDK as a dependency in this new integration directory using the command below. It references the path to where you downloaded the SDK. You should see a message in the terminal notifying you that you have successfully installed the SDK. (Edit the path in the command below if you are using an existing project directory):
42-
43-
`npm install ~/code/local/telesign_sdks/node_telesign_enterprise --save`
44-
45-
5. In your integration code, reference the package name "telesignenterprisesdk". You don't have to directly reference the full path to the SDK:
28+
2. Install the SDK as a dependency in the top-level directory of your project using the command below. Once the SDK is installed, you should see a message in the terminal notifying you that you have successfully installed the SDK.
4629

47-
`const TelesignSDK = require('telesignenterprisesdk');`
30+
`npm install telesignenterprisesdk --save`
4831

32+
This will also install the Telesign Self-service Node SDK since it is a dependency for the Full-service SDK.
4933

5034
## Authentication
5135

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "telesignenterprisesdk",
3-
"version": "3.0.0",
3+
"version": "3.0.1",
44
"description": "Official TeleSign SDK for Rest APIs including SMS, Voice, PhoneID, TeleBureau and more",
55
"repository": {
66
"type": "git",

0 commit comments

Comments
 (0)