Skip to content

Commit 3a15cb2

Browse files
authored
fix: package in readme installs/examples (#595)
see title --------- Signed-off-by: Todd Baert <[email protected]>
1 parent 9ece74c commit 3a15cb2

File tree

2 files changed

+14
-14
lines changed

2 files changed

+14
-14
lines changed

packages/server/README.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -16,16 +16,16 @@
1616
<img alt="Specification" src="https://img.shields.io/static/v1?label=specification&message=v0.7.0&color=yellow&style=for-the-badge" />
1717
</a>
1818
<!-- x-release-please-start-version -->
19-
<a href="https://github.com/open-feature/js-sdk/releases/tag/js-sdk-v1.6.2">
19+
<a href="https://github.com/open-feature/js-sdk/releases/tag/server-sdk-v1.6.2">
2020
<img alt="Release" src="https://img.shields.io/static/v1?label=release&message=v1.6.2&color=blue&style=for-the-badge" />
2121
</a>
2222
<!-- x-release-please-end -->
2323
<br/>
2424
<a href="https://open-feature.github.io/js-sdk/modules/OpenFeature_JS_SDK.html">
2525
<img alt="API Reference" src="https://img.shields.io/badge/reference-teal?logo=javascript&logoColor=white" />
2626
</a>
27-
<a href="https://www.npmjs.com/package/@openfeature/js-sdk">
28-
<img alt="NPM Download" src="https://img.shields.io/npm/dm/%40openfeature%2Fjs-sdk" />
27+
<a href="https://www.npmjs.com/package/@openfeature/server-sdk">
28+
<img alt="NPM Download" src="https://img.shields.io/npm/dm/%40openfeature%2Fserver-sdk" />
2929
</a>
3030
<a href="https://codecov.io/gh/open-feature/js-sdk">
3131
<img alt="codecov" src="https://codecov.io/gh/open-feature/js-sdk/branch/main/graph/badge.svg?token=3DC5XOEHMY" />
@@ -51,19 +51,19 @@
5151
#### npm
5252

5353
```sh
54-
npm install --save @openfeature/js-sdk
54+
npm install --save @openfeature/server-sdk
5555
```
5656

5757
#### yarn
5858

5959
```sh
60-
yarn add @openfeature/js-sdk
60+
yarn add @openfeature/server-sdk
6161
```
6262

6363
### Usage
6464

6565
```ts
66-
import { OpenFeature } from '@openfeature/js-sdk';
66+
import { OpenFeature } from '@openfeature/server-sdk';
6767

6868
// Register your feature flag provider
6969
OpenFeature.setProvider(new YourProviderOfChoice());
@@ -146,7 +146,7 @@ If the hook you're looking for hasn't been created yet, see the [develop a hook]
146146
Once you've added a hook as a dependency, it can be registered at the global, client, or flag invocation level.
147147

148148
```ts
149-
import { OpenFeature } from "@openfeature/js-sdk";
149+
import { OpenFeature } from "@openfeature/server-sdk";
150150

151151
// add a hook globally, to run on all evaluations
152152
OpenFeature.addHooks(new ExampleGlobalHook());
@@ -166,7 +166,7 @@ This behavior can be overridden by passing a custom logger either globally or pe
166166
A custom logger must implement the [Logger interface](../shared/src/logger/logger.ts).
167167

168168
```ts
169-
import type { Logger } from "@openfeature/js-sdk";
169+
import type { Logger } from "@openfeature/server-sdk";
170170

171171
// The logger can be anything that conforms with the Logger interface
172172
const logger: Logger = console;
@@ -186,7 +186,7 @@ A name is a logical identifier which can be used to associate clients with a par
186186
If a name has no associated provider, the global provider is used.
187187

188188
```ts
189-
import { OpenFeature, InMemoryProvider } from "@openfeature/js-sdk";
189+
import { OpenFeature, InMemoryProvider } from "@openfeature/server-sdk";
190190

191191
const myFlags = {
192192
'v2_enabled': {
@@ -219,7 +219,7 @@ Some providers support additional events, such as `PROVIDER_CONFIGURATION_CHANGE
219219
Please refer to the documentation of the provider you're using to see what events are supported.
220220

221221
```ts
222-
import { OpenFeature, ProviderEvents } from '@openfeature/js-sdk';
222+
import { OpenFeature, ProviderEvents } from '@openfeature/server-sdk';
223223

224224
// OpenFeature API
225225
OpenFeature.addHandler(ProviderEvents.Ready, (eventDetails) => {
@@ -239,7 +239,7 @@ The OpenFeature API provides a close function to perform a cleanup of all regist
239239
This should only be called when your application is in the process of shutting down.
240240

241241
```ts
242-
import { OpenFeature } from '@openfeature/js-sdk';
242+
import { OpenFeature } from '@openfeature/server-sdk';
243243

244244
await OpenFeature.close()
245245
```
@@ -253,7 +253,7 @@ This can be a new repository or included in [the existing contrib repository](ht
253253
You’ll then need to write the provider by implementing the [Provider interface](./src/provider/provider.ts) exported by the OpenFeature SDK.
254254

255255
```ts
256-
import { JsonValue, Provider, ResolutionDetails } from '@openfeature/js-sdk';
256+
import { JsonValue, Provider, ResolutionDetails } from '@openfeature/server-sdk';
257257

258258
// implement the provider interface
259259
class MyProvider implements Provider {
@@ -303,7 +303,7 @@ This can be a new repository or included in [the existing contrib repository](ht
303303
Implement your own hook by conforming to the [Hook interface](../shared/src/hooks/hook.ts).
304304

305305
```ts
306-
import type { Hook, HookContext, EvaluationDetails, FlagValue } from "@openfeature/js-sdk";
306+
import type { Hook, HookContext, EvaluationDetails, FlagValue } from "@openfeature/server-sdk";
307307

308308
export class MyHook implements Hook {
309309
after(hookContext: HookContext, evaluationDetails: EvaluationDetails<FlagValue>) {

packages/server/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@
5151
"@openfeature/shared": "*"
5252
},
5353
"typedoc": {
54-
"displayName": "OpenFeature JS SDK",
54+
"displayName": "OpenFeature Server SDK",
5555
"entryPoint": "./src/index.ts"
5656
}
5757
}

0 commit comments

Comments
 (0)