Ailur
/
jsStreams
2
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update the readme to be accurate

This commit is contained in:
Tracker-Friendly 2024-10-28 10:12:34 +00:00
parent 72d062ac0d
commit 3b9127c641
1 changed files with 3 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
README.md
View File

@ -1,7 +1,8 @@
# jsStreams
Go library to communicate with the JS Stream API by bridging the JS ReadableStream object to a Go io.ReaderCloser.
Go library to communicate with the JS Stream API by bridging the JS ReadableStream and WritableStream objects to a Go io.ReaderCloser and io.WriterCloser.
It also works vice versa, and with pipe readers/writers.
[![Go Report Card](https://goreportcard.com/badge/git.ailur.dev/ailur/jsStreams)](https://goreportcard.com/report/git.ailur.dev/ailur/jsStreams) [![Go Reference](https://pkg.go.dev/badge/git.ailur.dev/ailur/jsStreams.svg)](https://pkg.go.dev/git.ailur.dev/ailur/jsStreams)
The API is pretty self-explanatory - it provides a function to create an io.ReaderCloser from a JS ReadableStream object.
The API is pretty self-explanatory, see the Go Reference badge above for the full documentation.