Skip to content

Commit 53cf268

Browse files
committed
update readme
1 parent d4693e4 commit 53cf268

File tree

1 file changed

+17
-0
lines changed

1 file changed

+17
-0
lines changed

README.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -56,3 +56,20 @@ make test
5656
make start
5757
```
5858

59+
## Use the platform
60+
61+
### Generate Typescript code from platform protobufs
62+
```
63+
scripts/platform.sh
64+
```
65+
This will clone the platform repo and generate Typescript code in `lib/src/platform`.
66+
67+
### Import Typescript code
68+
69+
```
70+
import { GetAttributeRequest } from './lib/src/platform/policy/attributes/attributes_pb';
71+
const request = new GetAttributeRequest(<request data>);
72+
```
73+
74+
This is an example to import a `GetAttributeRequest` to request attribute information.
75+

0 commit comments

Comments
 (0)