@ampsec/platform-client 0.1.0 → 0.1.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +6 -6
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,11 +1,11 @@
|
|
|
1
|
-
# Amplifier Security -
|
|
1
|
+
# Amplifier Security - Platform Client
|
|
2
2
|
|
|
3
|
-
Collection of data models used by our Platform API.
|
|
3
|
+
Collection of data models, utilities, and clients used by and with our Platform API.
|
|
4
4
|
|
|
5
5
|
## Install
|
|
6
6
|
|
|
7
7
|
```sh
|
|
8
|
-
npm install @ampsec/platform-
|
|
8
|
+
npm install @ampsec/platform-client
|
|
9
9
|
```
|
|
10
10
|
|
|
11
11
|
## Usage
|
|
@@ -13,7 +13,7 @@ npm install @ampsec/platform-data
|
|
|
13
13
|
You can use the types by simply importing them.
|
|
14
14
|
|
|
15
15
|
```ts
|
|
16
|
-
import {UpsertUserDto} from '@ampsec/platform-
|
|
16
|
+
import {UpsertUserDto} from '@ampsec/platform-client'
|
|
17
17
|
|
|
18
18
|
const user: UpsertUserDto = {
|
|
19
19
|
id?: number;
|
|
@@ -39,12 +39,12 @@ npm run test
|
|
|
39
39
|
# Optional
|
|
40
40
|
npm link
|
|
41
41
|
cd /path/to/application
|
|
42
|
-
npm link @ampsec/platform-
|
|
42
|
+
npm link @ampsec/platform-client
|
|
43
43
|
```
|
|
44
44
|
|
|
45
45
|
### Generating Docs
|
|
46
46
|
|
|
47
|
-
Published to <https://amplifier-security.gitlab.io/amp-
|
|
47
|
+
Published to <https://amplifier-security.gitlab.io/ampsec-platform/amp-platform-client/>
|
|
48
48
|
|
|
49
49
|
```sh
|
|
50
50
|
npm run docs
|