Skip to content

Tweak root readme #67

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
May 13, 2022
Merged

Tweak root readme #67

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0d88090
docs: specify that we're in beta
ericcrosson-bitgo May 12, 2022
1fb30bb
docs: chop words
ericcrosson-bitgo May 12, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 17 additions & 13 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,22 +2,26 @@

![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.

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

Expand Down