Skip to content

Commit 62206d4

Browse files
committed
docs: add readme to library crate
1 parent 6111aef commit 62206d4

File tree

1 file changed

+44
-0
lines changed

1 file changed

+44
-0
lines changed

crates/typescript_tools/README.md

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
# TypeScript Tools 🦀
2+
3+
[![Build Status]](https://github.com/typescript-tools/monorepo/actions/workflows/release.yml)
4+
5+
[build status]: https://github.com/typescript-tools/monorepo/actions/workflows/release.yml/badge.svg?event=push
6+
7+
The **typescript-tools** are an opinionated collection of utilities for working with
8+
TypeScript monorepos. Read more in the [typescript-tools spec].
9+
10+
[typescript-tools spec]: https://github.com/typescript-tools/spec
11+
12+
## The Problem
13+
14+
Whereas [Lerna] was created for managing JavaScript monorepos, TypeScript monorepos have
15+
additional requirements introduced by the compilation step.
16+
17+
The [original and reference implementation] of the **typescript-tools** is written in
18+
TypeScript. The Rust implementation of the **typescript-tools** optimizes execution
19+
speed.
20+
21+
[lerna]: https://github.com/lerna/lerna
22+
[original and reference implementation]: https://github.com/typescript-tools/typescript-tools
23+
24+
## Goals
25+
26+
The goals of the typescript-tools are to give back the maximum amount of human time
27+
possible; chiefly through stability and aggressive automation.
28+
29+
The Rust implementation aims to minimize the amount of latency added to your monorepo's
30+
workflow.
31+
32+
## Supported Systems
33+
34+
The following target triples are supported:
35+
36+
- x86_64-unknown-linux-musl
37+
- i686-unknown-linux-musl
38+
- x86_64-apple-darwin
39+
- aarch64-unknown-linux-musl
40+
- aarch64-apple-darwin
41+
42+
## Install
43+
44+
Install from the Nix flake or download a precompiled binary from the GitHub Releases page.

0 commit comments

Comments
 (0)