From 180158187a0b29764334bccdb90644babc67ad46 Mon Sep 17 00:00:00 2001 From: raurir Date: Mon, 18 May 2020 14:15:42 +1000 Subject: [PATCH] update documentation for v3 release --- README.md | 14 +++++++++----- package.json | 2 +- 2 files changed, 10 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 2563975..01263d4 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,10 @@ # gatsby-plugin-asset-path -Move all of your JS and CSS build files, as well as the static folder into a subdirectory of your choice. +Copy all of your JS and CSS build files, as well as the static folder into a subdirectory of your choice. -## Breaking change in v1 +## Breaking change in v3 -Use `assetPrefix` instead of `pathPrefix` +No longer moves files due to gatsby's internal cache management. Copying files instead! ## Breaking change in v2 @@ -21,6 +21,10 @@ options: { Also note that `sitemap.xml` and the `page-data` folder were copied to assets folder before, now they are moved just as all other files this plugin handles. +## Breaking change in v1 + +Use `assetPrefix` instead of `pathPrefix` + ## Our use case Gatsby by default will generate all of the assets and put them directly at the root level: @@ -135,7 +139,7 @@ Stops Webpack from generating the .js.map files Default: `["static", "page-data"]` -The paths of files/folders to be moved to the asset directory. Do not add `icons` since these are copied and duplicated across `/public/icons/` and `/public/${assetPrefix}/`. +The paths of files/folders to be copied to the asset directory. Do not add `icons` since these are copied and duplicated across `/public/icons/` and `/public/${assetPrefix}/`. ```javascript // Your gatsby-config.js @@ -155,7 +159,7 @@ The paths of files/folders to be moved to the asset directory. Do not add `icons Default: `["js", "css"]` -The types of files in the root `publicFolder` to be moved to the asset directory. +The types of files in the root `publicFolder` to be copied to the asset directory. ```javascript // Your gatsby-config.js diff --git a/package.json b/package.json index e4dd083..db13e3c 100644 --- a/package.json +++ b/package.json @@ -1,7 +1,7 @@ { "name": "gatsby-plugin-asset-path", "version": "2.0.2", - "description": "Gatsby plugin that moves JS and CSS files and static folder to a custom folder", + "description": "Gatsby plugin that copies JS and CSS files and static folder to a custom folder", "main": "index.js", "scripts": { "build": "babel src --out-dir .",