Skip to content

Commit 8170536

Browse files
committed
README,docs: format and update URLs
Format docs with prettier. Update godoc.org URLs to pkg.go.dev.
1 parent 7502add commit 8170536

File tree

5 files changed

+313
-265
lines changed

5 files changed

+313
-265
lines changed

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ list of parameters, which can be supplied in any order. Duplicate parameters
4141
overwrite previous values.
4242

4343
See the full list of available options at
44-
<https://godoc.org/willnorris.com/go/imageproxy#ParseOptions>.
44+
<https://pkg.go.dev/willnorris.com/go/imageproxy#ParseOptions>.
4545

4646
### Remote URL
4747

@@ -76,7 +76,7 @@ source image][small-things], which measures 1024 by 678 pixels.
7676
| 200x,png | 200px wide, converted to PNG format | <a href="https://willnorris.com/api/imageproxy/200x,png/https://willnorris.com/images/imageproxy/small-things.jpg"><img src="https://willnorris.com/api/imageproxy/200x,png/https://willnorris.com/images/imageproxy/small-things.jpg" alt="200x,png"></a> |
7777
| cx175,cw400,ch300,100x | crop to 400x300px starting at (175,0), scale to 100px wide | <a href="https://willnorris.com/api/imageproxy/cx175,cw400,ch300,100x/https://willnorris.com/images/imageproxy/small-things.jpg"><img src="https://willnorris.com/api/imageproxy/cx175,cw400,ch300,100x/https://willnorris.com/images/imageproxy/small-things.jpg" alt="cx175,cw400,ch300,100x"></a> |
7878

79-
The [smart crop feature](https://godoc.org/willnorris.com/go/imageproxy#hdr-Smart_Crop)
79+
The [smart crop feature](https://pkg.go.dev/willnorris.com/go/imageproxy#hdr-Smart_Crop-ParseOptions)
8080
can best be seen by comparing crops of [this source image][judah-sheets], with
8181
and without smart crop enabled.
8282

@@ -182,7 +182,7 @@ first check an in-memory cache for an image, followed by a gcs bucket:
182182

183183
imageproxy -cache memory -cache gcs://my-bucket/
184184

185-
[tiered fashion]: https://godoc.org/github.com/die-net/lrucache/twotier
185+
[tiered fashion]: https://pkg.go.dev/github.com/die-net/lrucache/twotier
186186

187187
#### Cache Duration
188188

@@ -263,7 +263,7 @@ Reload the [codercat URL][], and you should see an error message. Now load a
263263
that it loads properly.
264264

265265
[signed codercat URL]: http://localhost:8080/500,sXyMwWKIC5JPCtlYOQ2f4yMBTqpjtUsfI67Sp7huXIYY=/https://octodex.github.com/images/codercat.jpg
266-
[signature option]: https://godoc.org/willnorris.com/go/imageproxy#hdr-Signature
266+
[signature option]: https://pkg.go.dev/willnorris.com/go/imageproxy#hdr-Signature-ParseOptions
267267

268268
Some simple code samples for generating signatures in various languages can be
269269
found in [docs/url-signing.md](/docs/url-signing.md). Multiple valid signature

0 commit comments

Comments
 (0)