Skip to content

Commit dd39eae

Browse files
committed
docs: readme updated
1 parent 0a9a75f commit dd39eae

File tree

1 file changed

+9
-5
lines changed

1 file changed

+9
-5
lines changed

README.md

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,11 @@
11
# Meteor SimpleSchema
2+
[![Meteor Community Package](https://img.shields.io/badge/Meteor-Package-green?logo=meteor&logoColor=white)](https://meteor.com)
3+
[![Test suite](https://github.com/Meteor-Community-Packages/meteor-simple-schema/actions/workflows/lint-test-publish.yml/badge.svg)](https://github.com/Meteor-Community-Packages/meteor-simple-schema/actions/workflows/lint-test-publish.yml)
4+
[![CodeQL](https://github.com/Meteor-Community-Packages/meteor-simple-schema/actions/workflows/github-code-scanning/codeql/badge.svg)](https://github.com/Meteor-Community-Packages/meteor-simple-schema/actions/workflows/github-code-scanning/codeql)
5+
[![Project Status: Active – The project has reached a stable, usable state and is being actively developed.](https://www.repostatus.org/badges/latest/active.svg)](https://www.repostatus.org/#active)
6+
![GitHub License](https://img.shields.io/github/license/Meteor-Community-Packages/meteor-simple-schema)
27

3-
> This package is back under maintenance by the Meteor Community Packages group
4-
5-
8+
> This package is back under maintenance by the Meteor Community Packages group 🚀
69
710
SimpleSchema validates JavaScript objects to ensure they match a schema. It can also clean the objects to automatically convert types, remove unsupported properties, and add automatic values such that the object is then more likely to pass validation.
811

@@ -13,7 +16,7 @@ There are a lot of similar packages for validating objects. These are some of th
1316
- Optional `Tracker` reactivity
1417
- Powerful customizable error message system with decent English language defaults and support for localization, which makes it easy to drop this package in and display the validation error messages to end users.
1518
- Has hundreds of tests and is used in production apps of various sizes
16-
- Used by the [Collection2](https://github.com/aldeed/meteor-collection2) and [AutoForm](https://github.com/aldeed/meteor-autoform) Meteor packages.
19+
- Used by the [Collection2](https://github.com/Meteor-Community-Packages/meteor-collection2) and [AutoForm](https://github.com/Meteor-Community-Packages/meteor-autoform) Meteor packages.
1720

1821
There are also reasons not to choose this package. Because of all it does, this package is more complex than (but still "simple" :) ) and slower than some other packages. Based on your needs, you should decide whether these tradeoffs are acceptable. One faster but less powerful option is [simplecheck](https://www.npmjs.com/package/simplecheck).
1922

@@ -103,7 +106,8 @@ There are also reasons not to choose this package. Because of all it does, this
103106

104107
## The History of SimpleSchema
105108

106-
SimpleSchema was first released as a Meteor package in mid-2013. Version 1.0 was released in September 2014. In mid-2016, version 2.0 was released as an NPM package, which can be used in Meteor, NodeJS, or static browser apps.
109+
SimpleSchema was first released as a Meteor package in mid-2013. Version 1.0 was released in September 2014.
110+
In mid-2016, new versions were released as an NPM package, which can be used in Meteor, NodeJS, or static browser apps.
107111
Afterwards it has been archived in favour of the NPM version.
108112

109113
In 2022/2023 the NPM package has dropped all Meteor compatibility and this package got released again, starting with the latest commit

0 commit comments

Comments
 (0)