diff --git a/templates/skeleton/app/assets/readme.md b/templates/skeleton/app/assets/readme.md new file mode 100644 index 0000000000..f0c6fb5c6c --- /dev/null +++ b/templates/skeleton/app/assets/readme.md @@ -0,0 +1,11 @@ +Use the `/app/assets` folder to store static files that **should be processed at build time**. + +Files in `/app/assets`: +- Get uploaded to the Shopify CDN on deployment + - `/app/assets/logo.png` → `cdn.shopify.com/0000/0000/0000/assets/logo.png` +- Can be imported in your app files + - Example: `import logo from '~/app/assets/logo.png'` +- Get processed by Hydrogen's build tools + - File names are likely to be hashed (`/app/assets/logo.svg` -> `/dist/assets/logo-p7f8c0gh.svg`) + - SVG images may be inlined + - CSS or JavaScript files may be chunked, uglified, and/or minified diff --git a/templates/skeleton/public/.gitkeep b/templates/skeleton/public/.gitkeep deleted file mode 100644 index e69de29bb2..0000000000 diff --git a/templates/skeleton/public/readme.md b/templates/skeleton/public/readme.md new file mode 100644 index 0000000000..62617f31d4 --- /dev/null +++ b/templates/skeleton/public/readme.md @@ -0,0 +1,7 @@ +Use the `/public` folder to store static files that **shouldn't be processed at build time**. + +Files in `/public`: +- Get uploaded to the Shopify CDN on deployment + - `/public/image.png` → `cdn.shopify.com/0000/0000/0000/image.png` +- Can't be imported in your app files (see `/app/assets` instead) +- Aren't processed by Hydrogen's build tools