Skip to content

Commit b6460d2

Browse files
committed
README tweaks
1 parent 33114db commit b6460d2

1 file changed

Lines changed: 7 additions & 8 deletions

File tree

README.md

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ import * as tea from "https://raw.github.com/teaxyz/lib/v0/mod.ts"
4242
import { porcelain } from "@teaxyz/lib";
4343
const { run } = porcelain;
4444

45-
await run(`python -c 'print("Hello, World!")'`).exec();
45+
await run(`python -c 'print("Hello, World!")'`);
4646
// ^^ installs python and its deps (into ~/.tea/python.org/v3.x.y)
4747
// ^^ runs the command
4848
// ^^ output goes to the terminal
@@ -98,7 +98,7 @@ useConfig({ prefix: Path.home().join(".local/share/my-app") });
9898
// ^^ must be done **before** any other libtea calls
9999

100100
const go = await install("go.dev");
101-
// ^^ /home/you/.local/share/my-app/go.dev/v1.20.4
101+
// ^^ go.path = /home/you/.local/share/my-app/go.dev/v1.20.4
102102
```
103103

104104
### Designed for Composibility
@@ -128,14 +128,11 @@ const { ConsoleLogger } = utils
128128
const { run } = porcelain
129129

130130
const logger = ConsoleLogger()
131-
await run("youtube-dl youtu.be/xiq5euezOEQ", logger).exec()
131+
await run("youtube-dl youtu.be/xiq5euezOEQ", { logger }).exec()
132132
```
133133

134134
### Caveats
135135

136-
We use a hook-like pattern because it is great. This library is not itself
137-
designed for React.
138-
139136
We have our own implementation of semver because open source has existed for
140137
decades and Semantic Versioning is much newer than that. Our implementation is
141138
quite compatible but not completely so. Use our semver with with libtea.
@@ -155,8 +152,10 @@ libtea almost certainly will not work in a browser. Potentially its possible.
155152
The first step would be compiling our bottles to WASM. We could use your help
156153
with that…
157154

158-
Windows is not yet supported, but we otherwise support everything tea/cli
159-
does.
155+
We use a hook-like pattern because it is great. This library is not itself
156+
designed for React.
157+
158+
We support the same platforms as [tea/cli].
160159

161160
## What Packages are Available?
162161

0 commit comments

Comments
 (0)