From 3b9127c641bbf80a0060c6c0477b2fb68daf7023 Mon Sep 17 00:00:00 2001 From: arzumify Date: Mon, 28 Oct 2024 10:12:34 +0000 Subject: [PATCH] Update the readme to be accurate --- README.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 5cf3c88..1752135 100644 --- a/README.md +++ b/README.md @@ -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. \ No newline at end of file +The API is pretty self-explanatory, see the Go Reference badge above for the full documentation. \ No newline at end of file