Updates README

Signed-off-by: Daniel Mahon <[email protected]>

README.md

@@ -2,22 +2,32 @@
 
 Convert image src(s) in markdown to be relative to their node's parent directory. This will help [gatsby-remark-images](https://github.com/gatsbyjs/gatsby/tree/master/packages/gatsby-remark-images) match images outside the node folder. For example, use with NetlifyCMS.
 
+NOTE: This was built for use with NetlifyCMS and should be considered a temporary solution until relative paths are supported. If it works for other use cases than great!
+
 ## Install
 
 `npm install --save gatsby-remark-relative-images`
 
 ## How to use
 
 ```javascript
-// In your gatsby-config.js
+// gatsby-config.js
 plugins: [
+  // Add static assets before markdown files
   {
     resolve: 'gatsby-source-filesystem',
     options: {
       path: `${__dirname}/static/uploads`,
       name: 'uploads',
     },
   },
+  {
+    resolve: 'gatsby-source-filesystem',
+    options: {
+      path: `${__dirname}/src/pages`,
+      name: 'pages',
+    },
+  },
   {
     resolve: `gatsby-transformer-remark`,
     options: {
@@ -26,11 +36,6 @@ plugins: [
         // go before gatsby-remark-images
         {
           resolve: `gatsby-remark-relative-images`,
-          options: {
-            // Set the name option to the same
-            // name you set for gatsby-source-filesystem
-            name: 'uploads', // default
-          },
         },
         {
           resolve: `gatsby-remark-images`,
@@ -47,8 +52,15 @@ plugins: [
 ];
 ```
 
-## Options
+### To convert frontmatter images
+
+Use the exported function `fmImagesToRelative` in your `gatsby-node.js`. This takes every node returned by your gatsby-source plugins and converts any absolute paths in markdown frontmatter data into relative paths if a matching file is found.
 
-| Name   | Default   | Description                                                                             |
-| ------ | --------- | --------------------------------------------------------------------------------------- |
-| `name` | `uploads` | Set the `name` option to the same `options.name` you set for `gatsby-source-filesystem` |
+```js
+// gatsby-node.js
+const { fmImagesToRelative } = require('gatsby-remark-relative-images');
+
+exports.onCreateNode = ({ node }) => {
+  fmImagesToRelative(node);
+};
+```