Skip to content

Commit 7acf9ac

Browse files
committed
docs(README): add badges
1 parent a972e87 commit 7acf9ac

File tree

1 file changed

+13
-0
lines changed

1 file changed

+13
-0
lines changed

README.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# @vinejs/compiler
22

3+
[![gh-workflow-image]][gh-workflow-url] [![npm-image]][npm-url] ![][typescript-image] [![license-image]][license-url] [![snyk-image]][snyk-url]
4+
35
The compiler is used to convert an array of schema nodes to a function with imperative JavaScript code that can be executed to validate a data object. The compiler operates at the low-level and does not offer any JavaScript API for creating the schema (see vinejs for user-land APIs).
46

57
## Schema
@@ -108,3 +110,14 @@ The validation rules are not executed by default when the field's value is `null
108110
## Writing value to the output
109111

110112
If the value of a field is `null` or `undefined` it will not be written to the output. However, the `null` values are written to the output when `allowNull` flag is enabled.
113+
114+
115+
[gh-workflow-image]: https://img.shields.io/github/actions/workflow/status/vinejs/compiler/test.yml?style=for-the-badge
116+
[gh-workflow-url]: https://github.com/vinejs/compiler/actions/workflows/test.yml 'Github action'
117+
[npm-image]: https://img.shields.io/npm/v/@vinejs/compiler/latest.svg?style=for-the-badge&logo=npm
118+
[npm-url]: https://www.npmjs.com/package/@vinejs/compiler/v/latest 'npm'
119+
[typescript-image]: https://img.shields.io/badge/Typescript-294E80.svg?style=for-the-badge&logo=typescript
120+
[license-url]: LICENSE.md
121+
[license-image]: https://img.shields.io/github/license/vinejs/compiler?style=for-the-badge
122+
[snyk-image]: https://img.shields.io/snyk/vulnerabilities/github/vinejs/compiler?label=Snyk%20Vulnerabilities&style=for-the-badge
123+
[snyk-url]: https://snyk.io/test/github/vinejs/compiler?targetFile=package.json 'snyk'

0 commit comments

Comments
 (0)