From 0d8809023bba9f725b1c0ada2445d615f0704ce4 Mon Sep 17 00:00:00 2001 From: Eric Crosson Date: Thu, 12 May 2022 18:29:11 -0500 Subject: [PATCH 1/2] docs: specify that we're in beta Woo-hoo, no longer in alpha! :tada: --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 329952b3..414f82ac 100644 --- a/README.md +++ b/README.md @@ -2,8 +2,8 @@ ![Build Status](https://github.com/BitGo/api-ts/actions/workflows/ci.yml/badge.svg?branch=master) -**Disclaimer: This project is currently in an alpha state. Documentation is actively -being worked on.** +**Disclaimer: This project is currently in beta state. Documentation is actively being +worked on.** A collection of packages for defining and using type-checked apis with TypeScript. From 1fb30bb8dd7f90e072b8a7d2d08ae14eb8c82682 Mon Sep 17 00:00:00 2001 From: Eric Crosson Date: Thu, 12 May 2022 18:47:32 -0500 Subject: [PATCH 2/2] docs: chop words and separate out the links to make it easier to read in monospace editors. --- README.md | 26 +++++++++++++++----------- 1 file changed, 15 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index 414f82ac..3d6c1905 100644 --- a/README.md +++ b/README.md @@ -7,17 +7,21 @@ worked on.** A collection of packages for defining and using type-checked apis with TypeScript. -TypeScript is a very powerful type system layered on top of JavaScript, but lacks type -information available at runtime. This is not likely to change because it is -[an explicit non-goal](https://github.com/Microsoft/TypeScript/wiki/TypeScript-Design-Goals#non-goals) -of TypeScript. [io-ts](https://github.com/gcanti/io-ts) fills in this functionality gap. -[io-ts-http](packages/io-ts-http/README.md) builds on top of `io-ts` to make it possible -to define codecs that translate between HTTP requests and plain JS objects. -Additionally, it provides a way to group these codecs into route definitions, and then -collect the route definitions into an api. The resulting api definitions may then be -used on the [client](packages/superagent-wrapper/README.md) and -[server](packages/express-wrapper/README.md) to have type-checked and runtime-validated -HTTP calls in a standardized manner. +TypeScript is a powerful type system layered on top of JavaScript, but lacks type +information about values received at runtime. This is [an explicit non-goal] of the +TypeScript language, so we use [io-ts] to statically type this runtime data. +[io-ts-http] builds on top of io-ts to define codecs that translate between HTTP +requests and plain old JavaScript objects. Additionally, it provides a way to group +these codecs into route definitions, and then collect the route definitions into an api. +The resulting api definitions may then be used on the [client] and [server] to have +type-checked and runtime-validated HTTP calls in a standardized manner. + +[an explicit non-goal]: + https://github.com/Microsoft/TypeScript/wiki/TypeScript-Design-Goals#non-goals +[io-ts]: https://github.com/gcanti/io-ts +[io-ts-http]: packages/io-ts-http/README.md +[client]: packages/superagent-wrapper/README.md +[server]: packages/express-wrapper/README.md ## Getting started