Add note about intended usage of gatsby-image

gatsbyjs · Dec 5, 2017 · 3008ab9 · 3008ab9
1 parent e104f5a
commit 3008ab9
Showing 1 changed file with 2 additions and 0 deletions.
diff --git a/packages/gatsby-image/README.md b/packages/gatsby-image/README.md
@@ -8,6 +8,8 @@ Gatsby's GraphQL queries. It combines
 capabilities with advanced image loading techniques to easily and completely
 optimize image loading for your sites.
 
+*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 of a container. Some ways you can use `<img/>` won't work with gatsby-image.*
+
 **[Demo](https://using-gatsby-image.gatsbyjs.org)**
 
 ## Problem