Skip to content

Commit bab7d48

Browse files
docs: expand README with detailed feature descriptions and access control documentation
1 parent 8b76df1 commit bab7d48

1 file changed

Lines changed: 9 additions & 2 deletions

File tree

README.md

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,11 @@
11
## 📦 Liquid Node Authenticator
22

3-
A Node.js connector library to integrate your microservices with [Liquid](https://github.com/shrihari-prakash/liquid) authentication services. This library requires Node version 18 or above.
3+
A Node.js client for [Liquid](https://github.com/shrihari-prakash/liquid) authentication services. You can use this library to:
4+
5+
- Authenticate and validate user tokens arriving at your microservice, including checking for specific scopes.
6+
- Manage client credentials and automatically cache access tokens for your microservice to talk directly to Liquid APIs (for retrieving user info, handling subscriptions, pushing custom data, etc).
7+
8+
Requires Node 18+.
49

510
### Installation
611

@@ -45,10 +50,12 @@ const { accessToken } = await liquidAuthenticator.getAccessToken();
4550

4651
#### Check if a scope is allowed for a token
4752

53+
Read more about configuring scopes and access control in the [Liquid documentation](https://liquid.shrihariprakasam.in/Understanding-Access-Control-and-Integrating-with-Other-Microservices).
54+
4855
```js
4956
const allowed = liquidAuthenticator.checkTokenScope(
5057
"your:scope:name",
51-
token /* tokenDetails object acqurired in authenticate() function */
58+
token /* tokenDetails object acqurired in authenticate() function */,
5259
);
5360

5461
if (allowed) {

0 commit comments

Comments
 (0)