Skip to content

Commit

Permalink
Describe default image size, #76 [skip ci]
Browse files Browse the repository at this point in the history
  • Loading branch information
terales committed Feb 6, 2018
1 parent d6bc77e commit 86bcf04
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 0 deletions.
2 changes: 2 additions & 0 deletions README.md
Expand Up @@ -52,6 +52,8 @@ https://socatar.com/twitter/yegor256/50-50
width - ^^ ^^ - height
```

If you omit size (ex. `https://socatar.com/twitter/yegor256`) than 100×100 image would be served. For you custom deployment you can modify it via environment variables, see [`.env-template`](.env-template).

### Getting help

Please, report anything via the GitHub issues: https://github.com/terales/socatar/issues.
Expand Down
4 changes: 4 additions & 0 deletions src/public/index.html
Expand Up @@ -76,6 +76,10 @@ <h3>Get images with size you need thanks to Cloudinary integration</h3>
which would ideally fit your dimentions.
</p>

<p>
If you omit size (ex. `https://socatar.com/twitter/yegor256`) than 100×100 image would be served.
</p>

<h3>Images load fast thanks to CDN and browser cache</h3>
<p>
All images are cached in Cloudinary for one week, Cloudflare and in a browser for two weeks, so after the first request, they will load very fast.
Expand Down

0 comments on commit 86bcf04

Please sign in to comment.