Skip to content

Commit 6d17f5a

Browse files
committed
docs(README.md): update README
1 parent 59588d8 commit 6d17f5a

File tree

3 files changed

+18
-27
lines changed

3 files changed

+18
-27
lines changed

README.md

Lines changed: 3 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -6,26 +6,7 @@
66
[![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](http://commitizen.github.io/cz-cli/)
77
[![npm version](https://badge.fury.io/js/%40jcoreio%2Ftypescript-validators.svg)](https://badge.fury.io/js/%40jcoreio%2Ftypescript-validators)
88

9-
This is my personal skeleton for creating an typescript library npm package. You are welcome to use it.
9+
Helps you write validators for TypeScript types, ensuring compile errors if your validator doesn't match the type.
10+
The validation errors are detailed. Adapted from the brilliant work in `flow-runtime`.
1011

11-
## Quick start
12-
13-
```sh
14-
npx 0-60 clone https://github.com/jcoreio/typescript-validators.git
15-
```
16-
17-
## Tools used
18-
19-
- babel 7
20-
- typescript
21-
- mocha
22-
- chai
23-
- istanbul
24-
- nyc
25-
- eslint
26-
- prettier
27-
- husky
28-
- semantic-release
29-
- renovate
30-
- Circle CI
31-
- Codecov.io
12+
WIP

package.json

Lines changed: 14 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -72,13 +72,23 @@
7272
"url": "https://github.com/jcoreio/typescript-validators.git"
7373
},
7474
"keywords": [
75-
"typescript",
76-
"validation",
77-
"validator",
7875
"api",
7976
"assertion",
8077
"assert",
81-
"validate"
78+
"defensive-programming",
79+
"json",
80+
"json-schema",
81+
"js-schema",
82+
"object-schema",
83+
"runtime-types",
84+
"schema",
85+
"type",
86+
"types",
87+
"typescript",
88+
"validate",
89+
"validation",
90+
"validation-schema",
91+
"validator"
8292
],
8393
"author": "Andy Edwards",
8494
"license": "MIT",

src/index.spec.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -369,7 +369,7 @@ describe(`smoke test`, function() {
369369
SecretKey: '22222222222222',
370370
},
371371
LiveChat: {
372-
License: '10730772',
372+
License: '222222222',
373373
},
374374
NotificationsApi: {
375375
Url: 'https://notifications-api.foo.com',

0 commit comments

Comments
 (0)