generated from okp4/template-oss
-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy pathREADME.md.template
36 lines (25 loc) · 2.1 KB
/
README.md.template
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
# AXONE {{ .Name }} schema
> Generated typescript types for [{{ .ContractName }} contract](https://github.com/axone-protocol/contracts/tree/{{ .Ref }}/contracts/{{ .ContractName }}).
[](https://github.com/axone-protocol/axone-contract-schema/releases)
[](https://github.com/axone-protocol/axone-contract-schema/actions/workflows/build.yml)
[](https://github.com/axone-protocol/axone-contract-schema/actions/workflows/lint.yml)
[](https://github.com/axone-protocol/axone-contract-schema/actions/workflows/test.yml)
[](https://conventionalcommits.org)
[](https://github.com/semantic-release/semantic-release)
[](https://github.com/axone-protocol/.github/blob/main/CODE_OF_CONDUCT.md)
[](https://opensource.org/licenses/BSD-3-Clause)
## Usage
First add or install the module to your existing project using either `yarn` or `npm`.
```bash
yarn add @axone/{{ .SchemaName }}
```
or
```bash
npm install --save @axone/{{ .SchemaName }}
```
Then import wanted type :
```typescript
import type { InstantiateMsg } from "@axone/{{ .SchemaName }}";
```
---
{{ .Docs }}