Update README for early collaboration

This commit is contained in:
Mike Cooper 2020-05-26 12:41:59 -07:00
Родитель 30ea9737eb
Коммит 8282a93230
Не найден ключ, соответствующий данной подписи
Идентификатор ключа GPG: 9424CEA6F89AB334
1 изменённых файлов: 16 добавлений и 3 удалений

Просмотреть файл

@ -1,9 +1,22 @@
# Rapid Experiments Schemas ![CircleCI](https://img.shields.io/circleci/build/github/mozilla/rapid-experiments-schemas)
# Rapid Experiments Shared ![CircleCI](https://img.shields.io/circleci/build/github/mozilla/rapid-experiments-shared)
This is a place to define schemas used across the rapid experiments program.
This is a place to define data and schemas used across the rapid experiments
program.
Any data that moves between systems should have a schema defined here. Schemas
are defined using Typescript, and automatically converted to JSON Schema.
are defined using Typescript, and automatically converted to JSON Schema. Any
data that needs to be re-used by multiple systems should be stored here to be
shared.
## Working on this repo
Common tasks are defined as Yarn scripts.
```shell
yarn install
yarn build
yarn test
```
## Using the schemas