Skip to content

Commit

Permalink
more README edits
Browse files Browse the repository at this point in the history
  • Loading branch information
j50n committed Jun 9, 2023
1 parent cca0be5 commit d89e736
Showing 1 changed file with 7 additions and 3 deletions.
10 changes: 7 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,9 +16,9 @@ When the new API is ready, there will be a 1.0 release and `mod.ts` will be
switched to the new API. The old API will continue to be maintained at `mod1.ts`
for some time after the Deno 2.0 release.

The old API was built on `Command.run()` which is now deprecated and scheduled
to be removed in Deno 2.0. There were other reasons to start over from scratch,
but this was the primary reason everything changed.
The old API was built on `Deno.run()` which is now deprecated and scheduled to
be removed in Deno 2.0. There were other reasons to start over from scratch, but
this was the primary reason everything changed.

## The New API

Expand All @@ -32,3 +32,7 @@ To use the new API:
The new API is stabilizing and the code is working. New tests are being added
regularly. Obviously the documentation is a work in progress. Refactors are
likely before the 1.0.0 release.

The new API is a nice way to work with `AsyncIterable` in general. It also
blends in a really nice way to work with child processes where things like
errors _just work_ and you don't have to worry about resource leaks.

0 comments on commit d89e736

Please sign in to comment.