Skip to content

Commit 50d8556

Browse files
authored
chore: improve readme (#95)
Co-authored-by: Yusinto Ngadiman <[email protected]>
1 parent a4fd6f0 commit 50d8556

File tree

1 file changed

+11
-3
lines changed

1 file changed

+11
-3
lines changed

packages/sdk/cloudflare/README.md

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,15 @@
22

33
[![NPM][sdk-cloudflare-npm-badge]][sdk-cloudflare-npm-link]
44
[![Actions Status][sdk-cloudflare-ci-badge]][sdk-cloudflare-ci]
5-
[![Documentation](https://img.shields.io/static/v1?label=GitHub+Pages&message=API+reference&color=00add8)](https://launchdarkly.github.io/js-core/packages/sdk/cloudflare/docs/)
5+
[![Documentation][sdk-cloudflare-ghp-badge]][sdk-cloudflare-ghp-link]
6+
[![NPM][sdk-cloudflare-dm-badge]][sdk-cloudflare-npm-link]
7+
[![NPM][sdk-cloudflare-dt-badge]][sdk-cloudflare-npm-link]
68

7-
This library supports using Cloudflare [Workers KV](https://developers.cloudflare.com/workers/learning/how-kv-works) to replace the default in-memory feature store of the [LaunchDarkly Node.js SDK](https://github.com/launchdarkly/cloudflare-server-sdk).
9+
The LaunchDarkly Cloudflare SDK is designed primarily for use in multi-user Cloudflare workers. It follows the server-side LaunchDarkly model for multi-user contexts. It is not intended for use in desktop and embedded systems applications.
810

9-
For more information, see the [SDK features guide](https://docs.launchdarkly.com/sdk/features/storing-data).
11+
For more information, see the [complete reference guide for this SDK](https://docs.launchdarkly.com/sdk/server-side/cloudflare).
12+
13+
This SDK is a beta version and should not be considered ready for production use while this message is visible.
1014

1115
## Install
1216

@@ -75,3 +79,7 @@ yarn test
7579
[sdk-cloudflare-ci]: https://github.com/launchdarkly/js-core/actions/workflows/cloudflare.yml
7680
[sdk-cloudflare-npm-badge]: https://img.shields.io/npm/v/@launchdarkly/cloudflare-server-sdk.svg?style=flat-square
7781
[sdk-cloudflare-npm-link]: https://www.npmjs.com/package/@launchdarkly/cloudflare-server-sdk
82+
[sdk-cloudflare-ghp-badge]: https://img.shields.io/static/v1?label=GitHub+Pages&message=API+reference&color=00add8
83+
[sdk-cloudflare-ghp-link]: https://launchdarkly.github.io/js-core/packages/sdk/cloudflare/docs/
84+
[sdk-cloudflare-dm-badge]: https://img.shields.io/npm/dm/@launchdarkly/cloudflare-server-sdk.svg?style=flat-square
85+
[sdk-cloudflare-dt-badge]: https://img.shields.io/npm/dt/@launchdarkly/cloudflare-server-sdk.svg?style=flat-square

0 commit comments

Comments
 (0)