updated doc

jlangch · Oct 20, 2023 · 13ac722 · 13ac722
1 parent 3e4e4eb
commit 13ac722
Show file tree

Hide file tree

Showing 2 changed files with 35 additions and 4 deletions.
diff --git a/doc/readme/json-lines.md b/doc/readme/json-lines.md
@@ -45,7 +45,11 @@ converted. E.g. there is no real decimal type and Venice `int` is converted to `
 
 ### Streams
 
-JSON Lines can be spit to Java OutputStreams, Writers, or files
+JSON can be spit to Java OutputStreams, Writers, or files:
+ * `io/bytebuf-out-stream`
+ * `io/file-out-stream`
+ * `io/buffered-writer`
+ * `io/file`
 
 ```clojure
 (do
@@ -73,7 +77,20 @@ JSON Lines can be spit to Java OutputStreams, Writers, or files
     (flush wr)))
 ```
 
-JSON can be slurped from Java InputStreams, Readers, or files
+
+JSON can be slurped from byte buffers, Java InputStreams, Readers, or files:
+ * `bytebuf`
+ * `io/file-in-stream`
+ * `io/bytebuf-in-stream`
+ * `io/buffered-reader`
+ * `io/file`
+
+```clojure
+(do
+  (load-module :jsonl)
+
+  (jsonl/slurp (io/file "data.jsonl")))
+```
 
 ```clojure
 (do

diff --git a/doc/readme/json.md b/doc/readme/json.md
@@ -23,7 +23,11 @@ converted. E.g. there is no real decimal type and Venice `int` is converted to `
 
 ### Streams
 
-JSON can be spit to Java OutputStreams, Writers, or files
+JSON can be spit to Java OutputStreams, Writers, or files:
+ * `io/bytebuf-out-stream`
+ * `io/file-out-stream`
+ * `io/buffered-writer`
+ * `io/file`
 
 ```clojure
 (let [out (io/bytebuf-out-stream)]
@@ -33,7 +37,17 @@ JSON can be spit to Java OutputStreams, Writers, or files
 ;;=> "{\"a\":100,\"b\":100,\"c\":[10,20,30]}"
 ```
 
-JSON can be slurped from Java InputStreams, Readers, or files
+
+JSON can be slurped from byte buffers, Java InputStreams, Readers, or files:
+ * `bytebuf`
+ * `io/file-in-stream`
+ * `io/bytebuf-in-stream`
+ * `io/buffered-reader`
+ * `io/file`
+
+```clojure
+(json/slurp (io/file "data.jsonl"))
+```
 
 ```clojure
 (let [json (json/write-str {:a 100 :b 100})]