summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorLuke Shumaker <lukeshu@lukeshu.com>2023-01-26 13:59:35 -0700
committerLuke Shumaker <lukeshu@lukeshu.com>2023-01-29 02:14:35 -0700
commitcf062e09037c7e54a821b05ef50b3e86683090f8 (patch)
tree2774971350856aba2c0607827eece0cabd63de52 /README.md
parent403c22024921af1d66c6a3de7ee6431043465c39 (diff)
Improve/fix documentation and comments
Diffstat (limited to 'README.md')
-rw-r--r--README.md4
1 files changed, 4 insertions, 0 deletions
diff --git a/README.md b/README.md
index c8e05ab..955258c 100644
--- a/README.md
+++ b/README.md
@@ -128,6 +128,10 @@ lowmemjson.NewEncoder(&lowmemjson.ReEncoder{
}).Encode(val)
```
+`*Encoder` and `*ReEncoder` both tend to make many small writes; if
+writes are syscalls, you may want to wrap their output in a
+`bufio.Writer`.
+
### Callee API
For defining Go types with custom JSON representations, `lowmemjson`