jsonschema: improve doc (#122)
Improve the package documentation. Add a README and LICENSE, anticipating the relocation of this package to its own module elsewhere.
This commit is contained in:
parent
78a66a438a
commit
0f596bde17
1 changed files with 106 additions and 18 deletions
39
jsonschema/README.md
Normal file
39
jsonschema/README.md
Normal file
|
|
@ -0,0 +1,39 @@
|
|||
TODO: this file should live at the root of the jsonschema-go module,
|
||||
above the jsonschema package.
|
||||
|
||||
# JSON Schema for GO
|
||||
|
||||
This module implements the [JSON Schema](https://json-schema.org/) specification.
|
||||
The `jsonschema` package supports creating schemas, validating JSON values
|
||||
against a schema, and inferring a schema from a Go struct. See the package
|
||||
documentation for usage.
|
||||
|
||||
## Contributing
|
||||
|
||||
This module welcomes external contributions.
|
||||
It has no dependencies outside of the standard library, and can be built with
|
||||
the standard Go toolchain. Run `go test ./...` at the module root to run all
|
||||
the tests.
|
||||
|
||||
## Issues
|
||||
|
||||
This project uses the [GitHub issue
|
||||
tracker](https://github.com/TODO/jsonschema-go/issues) for bug reports, feature requests, and other issues.
|
||||
|
||||
Please [report
|
||||
bugs](https://github.com/TODO/jsonschema-go/issues/new). If the SDK is
|
||||
not working as you expected, it is likely due to a bug or inadequate
|
||||
documentation, and reporting an issue will help us address this shortcoming.
|
||||
|
||||
When reporting a bug, make sure to answer these five questions:
|
||||
|
||||
1. What did you do?
|
||||
2. What did you see?
|
||||
3. What did you expect to see?
|
||||
4. What version of the Go MCP SDK are you using?
|
||||
5. What version of Go are you using (`go version`)?
|
||||
|
||||
## License
|
||||
|
||||
This project is licensed under the MIT license. See the LICENSE file for details.
|
||||
|
||||
Loading…
Reference in a new issue