Skip to content

Commit 57e10df

Browse files
committed
minor copyedits, add caution re server-side node
1 parent 464c731 commit 57e10df

File tree

1 file changed

+20
-5
lines changed

1 file changed

+20
-5
lines changed

README.md

Lines changed: 20 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,22 @@
1-
### LaunchDarkly Sample TypeScript Node.js Application ###
2-
We've built a simple console application that demonstrates how LaunchDarkly's SDK works. Below, you'll find the basic build procedure, but for more comprehensive instructions, you can visit your [Quickstart page](https://app.launchdarkly.com/quickstart#/).
1+
# LaunchDarkly sample TypeScript Node.js (server-side) application
2+
3+
We've built a simple console application that demonstrates how LaunchDarkly's SDK works.
4+
5+

Below, you'll find the build procedure. For more comprehensive instructions, you can visit your [Quickstart page](https://app.launchdarkly.com/quickstart#/) or the [Node.js (server-side) reference guide](https://docs.launchdarkly.com/sdk/server-side/node-js).
6+
7+
The LaunchDarkly server-side SDK for Node.js is designed primarily for use in multi-user systems such as web servers and applications. It follows the server-side LaunchDarkly model for multi-user contexts. It is not intended for use in desktop and embedded systems applications.
8+
9+
For a sample application demonstrating how to use LaunchDarkly in *client-side* Node.js applications, refer to our [Client-side Node.js SDK sample application](https://github.com/launchdarkly/hello-node-client).
10+
11+
## Build instructions
312

4-
##### Build instructions #####
513
1. Install the LaunchDarkly Node.js SDK by running `npm install`
6-
2. Copy your API key and feature flag key from your LaunchDarkly dashboard into `index.ts`
7-
3. Run `npm start`
14+
2. Edit `index.ts` and set the value of `sdkKey` to your LaunchDarkly SDK key. If there is an existing boolean feature flag in your LaunchDarkly project that you want to evaluate, set `featureFlagKey` to the flag key.
15+
16+
```js
17+
const sdkKey = "1234567890abcdef";
18+
19+
const featureFlagKey = "my-flag";
20+
```
21+
22+
3. Run `npm start`

0 commit comments

Comments
 (0)