|
| 1 | +# LaunchDarkly Node.js Client-Side SDK |
| 2 | + |
| 3 | +<!-- |
| 4 | +[![NPM][npm-badge]][npm-link] |
| 5 | +[![Actions Status][ci-badge]][ci-link] |
| 6 | +[![Documentation][ghp-badge]][ghp-link] |
| 7 | +[![NPM][npm-dm-badge]][npm-link] |
| 8 | +[![NPM][npm-dt-badge]][npm-link] |
| 9 | +--> |
| 10 | + |
| 11 | +> [!CAUTION] |
| 12 | +> This SDK is experimental and should NOT be considered ready for production use. |
| 13 | +> It may change or be removed without notice and is not subject to backwards |
| 14 | +> compatibility guarantees. |
| 15 | +
|
| 16 | +<!-- |
| 17 | +> Pin to a specific minor version and review the [changelog](link-to-changelog) before upgrading. |
| 18 | +--> |
| 19 | + |
| 20 | +## Getting started |
| 21 | + |
| 22 | +Refer to the [SDK documentation](https://launchdarkly.com/docs/sdk/client-side/node-js#getting-started) for instructions on getting started with using the SDK. |
| 23 | + |
| 24 | +## About LaunchDarkly |
| 25 | + |
| 26 | +- LaunchDarkly is a continuous delivery platform that provides feature flags as a service and allows developers to iterate quickly and safely. We allow you to easily flag your features and manage them from the LaunchDarkly dashboard. With LaunchDarkly, you can: |
| 27 | + - Roll out a new feature to a subset of your users (like a group of users who opt-in to a beta tester group), gathering feedback and bug reports from real-world use cases. |
| 28 | + - Gradually roll out a feature to an increasing percentage of users, and track the effect that the feature has on key metrics (for instance, how likely is a user to complete a purchase if they have feature A versus feature B?). |
| 29 | + - Turn off a feature that you realize is causing performance problems in production, without needing to re-deploy, or even restart the application with a changed configuration file. |
| 30 | + - Grant access to certain features based on user attributes, like payment plan (eg: users on the 'gold' plan get access to more features than users in the 'silver' plan). |
| 31 | + - Disable parts of your application to facilitate maintenance, without taking everything offline. |
| 32 | +- LaunchDarkly provides feature flag SDKs for a wide variety of languages and technologies. Read [our documentation](https://docs.launchdarkly.com/sdk) for a complete list. |
| 33 | +- Explore LaunchDarkly |
| 34 | + - [launchdarkly.com](https://www.launchdarkly.com/ 'LaunchDarkly Main Website') for more information |
| 35 | + - [docs.launchdarkly.com](https://docs.launchdarkly.com/ 'LaunchDarkly Documentation') for our documentation and SDK reference guides |
| 36 | + - [apidocs.launchdarkly.com](https://apidocs.launchdarkly.com/ 'LaunchDarkly API Documentation') for our API documentation |
| 37 | + - [blog.launchdarkly.com](https://blog.launchdarkly.com/ 'LaunchDarkly Blog Documentation') for the latest product updates |
| 38 | + |
| 39 | + |
| 40 | +<!-- |
| 41 | +[npm-badge]: https://img.shields.io/npm/v/@launchdarkly/node-client-sdk.svg?style=flat-square |
| 42 | +[npm-link]: https://www.npmjs.com/package/@launchdarkly/node-client-sdk |
| 43 | +[npm-dm-badge]: https://img.shields.io/npm/dm/@launchdarkly/node-client-sdk.svg?style=flat-square |
| 44 | +[npm-dt-badge]: https://img.shields.io/npm/dt/@launchdarkly/node-client-sdk.svg?style=flat-square |
| 45 | +[ci-badge]: https://github.com/launchdarkly/js-core/actions/workflows/node-client.yml/badge.svg |
| 46 | +[ci-link]: https://github.com/launchdarkly/js-core/actions/workflows/node-client.yml |
| 47 | +[ghp-badge]: https://img.shields.io/static/v1?label=GitHub+Pages&message=API+reference&color=00add8 |
| 48 | +[ghp-link]: https://launchdarkly.github.io/js-core/packages/sdk/node-client/docs/ |
| 49 | +--> |
0 commit comments