Skip to content

Commit 0169f12

Browse files
committed
update README
1 parent fc4e863 commit 0169f12

File tree

1 file changed

+3
-7
lines changed

1 file changed

+3
-7
lines changed

README.md

Lines changed: 3 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,6 @@
33
[![Go Doc](https://img.shields.io/badge/godoc-reference-blue.svg?style=flat-square)](https://godoc.org/github.com/metafates/schema)
44
[![Go Report Card](https://goreportcard.com/badge/github.com/metafates/schema)](https://goreportcard.com/report/github.com/metafates/schema)
55

6-
> Work in progress!
7-
86
<img src="https://github.com/user-attachments/assets/54aafdf2-df4d-4b92-9a46-37bc59d99e6e" align="right" width=300 />
97

108
Go schema declaration and validation with static types.
@@ -15,14 +13,12 @@ The goal is to eliminate duplicative type declarations.
1513
You declare a schema once and it will be used as both schema and type itself.
1614
It's easy to compose simpler types into complex data structures.
1715

18-
No stable version yet, but you can use it like that.
16+
Install:
1917

2018
```bash
21-
go get github.com/metafates/schema@main
19+
go get github.com/metafates/schema
2220
```
2321

24-
**Work in progress, API may change significantly without further notice!**
25-
2622
## Features
2723

2824
- Type-safe
@@ -386,7 +382,7 @@ BenchmarkUnmarshalJSON/codegen/without_validation-12 45649 ns/op
386382
## TODO
387383

388384
- [x] Support for manual construction (similar to `.parse(...)` in zod) (using codegen)
389-
- [ ] Stabilize API
385+
- [x] Stabilize API
390386
- [x] Better documentation
391387
- [x] More tests
392388
- [x] Improve performance. It should not be a bottleneck for most usecases, especially for basic CRUD apps. Still, there is a room for improvement!

0 commit comments

Comments
 (0)