Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
KyleAMathews committed Feb 13, 2018
1 parent 18cad36 commit 8393625
Showing 1 changed file with 5 additions and 8 deletions.
13 changes: 5 additions & 8 deletions packages/gatsby-image/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,9 @@ Speedy, optimized images without the work.
Gatsby's GraphQL queries. It combines
[Gatsby's native image processing](https://image-processing.gatsbyjs.org/)
capabilities with advanced image loading techniques to easily and completely
optimize image loading for your sites. `gatsby-image` makes use of
optimize image loading for your sites. `gatsby-image` uses
[gatsby-plugin-sharp](https://www.gatsbyjs.org/packages/gatsby-plugin-sharp/)
internally and all its methods are available for usage.
to power its image transformations.

_Warning: gatsby-image is **not** a drop-in replacement for `<img/>`. It's
optimized for fixed width/height images and images that stretch the full-width
Expand Down Expand Up @@ -257,12 +257,9 @@ prop. e.g. `<Img sizes={sizes} />`
| `backgroundColor` | `string\|bool` | Set a colored background placeholder. If true, uses "lightgray" for the color. You can also pass in any valid color string. |
| `onLoad` | `func` | A callback that is called when the full-size image has loaded. |

_Please Note :
You can pass parameters for more detailed options on these props, like assigning
`quality`,`sizeByPixelDensity`,`pngCompressionLevel`,`cropFocus`,`greyscale`
and many more.
We use [gatsby-plugin-sharp](/packages/gatsby-plugin-sharp) to set these
parameters._
## Image processing arguments
[gatsby-plugin-sharp](/packages/gatsby-plugin-sharp) supports many additional arguments for transforming your images like
`quality`,`sizeByPixelDensity`,`pngCompressionLevel`,`cropFocus`,`greyscale` and many more. See its documentation for more.

## Some other stuff to be aware of

Expand Down

0 comments on commit 8393625

Please sign in to comment.