Skip to content

Commit b4d993b

Browse files
authored
Merge pull request #10 from unlaunch/develop
Develop
2 parents 9b084b2 + 95fece3 commit b4d993b

File tree

1 file changed

+20
-6
lines changed

1 file changed

+20
-6
lines changed

README.md

Lines changed: 20 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,35 @@
1+
# Unlaunch Node.js SDK
2+
13
## Overview
2-
The Unlaunch Node.js SDK provides a Node.js API to access Unlaunch feature flags and other features.
3-
Using the SDK, you can easily build Java applications that can evaluate feature flags, dynamic configurations, and more.
4+
The Unlaunch Node.js SDK provides a Node.js API to access Unlaunch feature flags and other features. Using this SDK, you can easily build Javascript applications that can evaluate feature flags, dynamic configurations, and more.
45

56
### Important Links
67

7-
- To create feature flags to use with Node SDK, login to your Unlaunch Console at [https://app.unlaunch.io](https://app.unlaunch.io)
8+
- To create feature flags to use with Node.js SDK, login to your Unlaunch Console at [https://app.unlaunch.io](https://app.unlaunch.io)
89
- [Official Guide](https://docs.unlaunch.io/docs/sdks/nodejs-sdk)
910
- [Documentation](https://github.com/unlaunch/nodejs-sdk#section-documentation)
1011
- [Example Project](https://github.com/unlaunch/hello-node)
1112

1213
## Getting Started
13-
Here is a simple example.
1414

15-
```$xslt
15+
First install the Node SDK using your package manager.
16+
17+
```
18+
npm install --save unlaunch-node-sdk
19+
```
20+
21+
Next, import the UnlaunchFactory into your application.
22+
23+
```javascript
24+
import {UnlaunchFactory} from 'unlaunch-node-sdk';
25+
```
26+
27+
Here is a simple example showing how to use the this SDK in your Node.js application.
28+
29+
```javascript
1630
let factory = UnlaunchFactory({
1731
core:{
18-
sdkKey:'prod-sdk-9b6cf021-a1b5-4b30-9b39-533bb0c9f4b3'
32+
sdkKey:'INSERT_YOUR_SDK_KEY'
1933
},
2034
intervals: {
2135
// fetch feature updates each 30 sec

0 commit comments

Comments
 (0)