@chill-institute/contracts 2.3.3 → 2.3.4
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 +2 -20
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -2,9 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
|
|
4
4
|
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
This repo is the boundary between the backend, web app, CLI, and downstream consumers. It owns protobuf schemas plus generated Go, TypeScript, and OpenAPI artifacts.
|
|
5
|
+
Schemas and generated clients for the public [chill.institute](https://chill.institute) API.
|
|
8
6
|
|
|
9
7
|
## Install
|
|
10
8
|
|
|
@@ -20,26 +18,10 @@ Go consumers:
|
|
|
20
18
|
go get github.com/chill-institute/chill-contracts
|
|
21
19
|
```
|
|
22
20
|
|
|
23
|
-
## Develop
|
|
24
|
-
|
|
25
|
-
```bash
|
|
26
|
-
mise install
|
|
27
|
-
mise run generate
|
|
28
|
-
mise run verify
|
|
29
|
-
```
|
|
30
|
-
|
|
31
|
-
Regenerate artifacts after changing protobuf definitions and commit schema plus generated output together.
|
|
32
|
-
|
|
33
21
|
## Docs
|
|
34
22
|
|
|
35
23
|
- [API reference](./docs/API.md): generated contract surface
|
|
36
24
|
- [Architecture](./docs/ARCHITECTURE.md): package layout and generation flow
|
|
37
25
|
- [Security](./SECURITY.md): reporting and contract safety notes
|
|
38
26
|
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
Please read the [contributing guide](./CONTRIBUTING.md).
|
|
42
|
-
|
|
43
|
-
## License
|
|
44
|
-
|
|
45
|
-
Licensed under the [MIT License](./LICENSE).
|
|
27
|
+
[Contributing](./CONTRIBUTING.md) · [MIT License](./LICENSE)
|