11# Directory JavaScript SDK
22
3- [ ![ Release] ( https://img.shields.io/github/v/release/agntcy/dir-sdk-javascript )] ( CHANGELOG.md )
4-
5- ## About The Project
3+ ## Overview
64
75Dir JavaScript SDK provides a simple way to interact with the Directory API.
86It allows developers to integrate and use Directory functionality from their applications with ease.
97The SDK supports both JavaScript and TypeScript applications.
108
119** Note for users:** The SDK is intended for use in Node.js applications and will not work in Web applications.
1210
11+ ## Features
12+
1313The Directory SDK provides comprehensive access to all Directory APIs with a simple, intuitive interface:
1414
1515### ** Store API**
@@ -39,42 +39,10 @@ The Directory SDK provides comprehensive access to all Directory APIs with a sim
3939- ** Error Handling** : Comprehensive gRPC error handling with detailed error messages
4040- ** Configuration** : Flexible configuration via environment variables or direct instantiation
4141
42- ## Getting Started
42+ ## Installation
4343
4444Install the SDK using one of available JS package managers like [ npm] ( https://www.npmjs.com/ )
4545
46- ### Prerequisites
47-
48- - [ NodeJS] ( https://nodejs.org/en/ ) - JavaScript runtime
49- - [ npm] ( https://www.npmjs.com/ ) - Package manager
50- - [ dirctl] ( https://github.com/agntcy/dir/releases ) - Directory CLI binary
51- - Directory server instance (see setup below)
52-
53- ### 1. Server Setup
54-
55- ** Option A: Local Development Server**
56-
57- ``` bash
58- # Clone the repository and start the server using Taskfile
59- task server:start
60- ```
61-
62- ** Option B: Custom Server**
63-
64- ``` bash
65- # Set your Directory server address
66- export DIRECTORY_CLIENT_SERVER_ADDRESS=" your-server:8888"
67- ```
68-
69- ### 2. SDK Installation
70-
71- ``` bash
72- # Add the Directory SDK
73- npm install agntcy-dir
74- ```
75-
76- ### Installation
77-
78461 . Initialize the project:
7947``` bash
8048npm init -y
@@ -85,7 +53,7 @@ npm init -y
8553npm install agntcy-dir
8654```
8755
88- ## Usage
56+ ## Configuration
8957
9058The SDK can be configured via environment variables or direct instantiation:
9159
@@ -174,36 +142,43 @@ await client.authenticateOAuthPkce();
174142
175143For custom transports, call ` Client.createGRPCTransport(oidcConfig, { oidcTokenHolder }) ` with an ` OAuthTokenHolder ` (exported from this package). The usual path is ` new Client(oidcConfig) ` , which wires the holder and transport automatically.
176144
177- ### Usage Examples
145+ ## Getting Started
178146
179- See the [ Example JavaScript Project ] ( ../examples/example-js/ ) for a complete working example that demonstrates all SDK features.
147+ ### Prerequisites
180148
181- ``` bash
182- npm install
183- npm run example
184- ```
149+ - [ NodeJS] ( https://nodejs.org/en/ ) - JavaScript runtime
150+ - [ npm] ( https://www.npmjs.com/ ) - Package manager
151+ - [ dirctl] ( https://github.com/agntcy/dir/releases ) - Directory CLI binary
152+ - Directory server instance (see setup below)
153+
154+ ### 1. Server Setup
185155
186- _ For more examples, please refer to the [ Documentation] ( https://example.com ) or
187- the [ Wiki] ( https://github.com/agntcy/dir-sdk-javascript/wiki ) _
156+ ** Option A: Local Development Server**
188157
189- ## Roadmap
158+ ``` bash
159+ # Clone the repository and start the server using Taskfile
160+ task server:start
161+ ```
190162
191- See the [ open issues] ( https://github.com/agntcy/dir-sdk-javascript/issues ) for a list
192- of proposed features (and known issues).
163+ ** Option B: Custom Server**
193164
194- ## Contributing
165+ ``` bash
166+ # Set your Directory server address
167+ export DIRECTORY_CLIENT_SERVER_ADDRESS=" your-server:8888"
168+ ```
195169
196- Contributions are what make the open source community such an amazing place to
197- learn, inspire, and create. Any contributions you make are ** greatly
198- appreciated** . For detailed contributing guidelines, please see
199- [ CONTRIBUTING.md] ( CONTRIBUTING.md )
170+ ### 2. SDK Installation
200171
201- ## License
172+ ``` bash
173+ # Add the Directory SDK
174+ npm install agntcy-dir
175+ ```
202176
203- Distributed under the Apache 2.0 License. See [ LICENSE] ( LICENSE ) for more
204- information.
177+ ### Usage Examples
205178
206- ## Contact
179+ See the [ Example JavaScript Project ] ( ../examples/example-js/ ) for a complete working example that demonstrates all SDK features.
207180
208- Project Link:
209- [ https://github.com/agntcy/dir-sdk-javascript ] ( https://github.com/agntcy/dir-sdk-javascript )
181+ ``` bash
182+ npm install
183+ npm run example
184+ ```
0 commit comments