Skip to content

Commit a28e609

Browse files
authored
Enhance README with SDK functionality description (#572)
Added a brief description of the REST API SDK's functionality.
1 parent ad39fa2 commit a28e609

File tree

1 file changed

+4
-1
lines changed

1 file changed

+4
-1
lines changed

packages/rest-api-sdk/README.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,14 @@
11
# @reflag/rest-api-sdk (beta)
22

33
Typed SDK for Reflag's REST API.
4+
The REST API SDK is a management API which lets you list flags and toggle flags for users and companies amongst other things.
5+
6+
See [Customer Admin Panel](https://github.com/reflagcom/javascript/blob/roncohen-patch-1/packages/rest-api-sdk/examples/customer-admin-panel/README.md) for an example of what's possible with the REST API SDK.
47

58
## Installation
69

710
```bash
8-
npm install @reflag/rest-api-sdk
11+
npm i @reflag/rest-api-sdk
912
# or
1013
yarn add @reflag/rest-api-sdk
1114
```

0 commit comments

Comments
 (0)