Skip to content

Commit

Permalink
📝 Updated Readme
Browse files Browse the repository at this point in the history
  • Loading branch information
slashformotion committed Jan 1, 2022
1 parent bca4bfd commit d1c0d6f
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,21 +9,21 @@ Package pbm implements a Portable Bit Map (PBM) image decoder and encoder. The s
The PBM specification is at http://netpbm.sourceforge.net/doc/pbm.html.


## func [Decode](reader.go#L28)
## func Decode
<pre>
func Decode(r <a href="https://pkg.go.dev/io">io</a>.<a href="https://pkg.go.dev/io#Reader">Reader</a>) (<a href="https://pkg.go.dev/image">image</a>.<a href="https://pkg.go.dev/image#Image">Image</a>, <a href="https://pkg.go.dev/builtin#error">error</a>)
</pre>
Decode reads a PBM image from Reader r and returns it as an image.Image.


## func [DecodeConfig](reader.go#L39)
## func DecodeConfig
<pre>
func DecodeConfig(r <a href="https://pkg.go.dev/io">io</a>.<a href="https://pkg.go.dev/io#Reader">Reader</a>) (<a href="https://pkg.go.dev/image">image</a>.<a href="https://pkg.go.dev/image#Config">Config</a>, <a href="https://pkg.go.dev/builtin#error">error</a>)
</pre>
DecodeConfig returns the color model and dimensions of a PBM image without decoding the entire image.


## func [Encode](writer.go#L15)
## func Encode
<pre>
func Encode(w <a href="https://pkg.go.dev/io">io</a>.<a href="https://pkg.go.dev/io#Writer">Writer</a>, img <a href="https://pkg.go.dev/image">image</a>.<a href="https://pkg.go.dev/image#Image">Image</a>) <a href="https://pkg.go.dev/builtin#error">error</a>
</pre>
Expand Down

0 comments on commit d1c0d6f

Please sign in to comment.