diff --git a/README.md b/README.md index fb3f857e..6775d469 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,15 @@ # Netlify Plugin Edge Handlers -This plugin is used to bundle Edge Handlers for deployment. It is included in the list of core plugins in Netlify's build, meaning that any handler under the `./edge-handlers` directory will be bundled by Netlify's buildbot. +This plugin is used to bundle Edge Handlers for deployment. It is included in the list of core plugins in Netlify's +build, meaning that any handler under the `./edge-handlers` directory will be bundled by Netlify's buildbot. ## Usage -This plugin is already integrated into Netlify's build process and will not need to be included in your project for Edge Handlers to work. +This plugin is already integrated into Netlify's build process and will not need to be included in your project for Edge +Handlers to work. -To run this plugin locally in an existing project that has edge handlers, you'll need to install the netlify build codebase locally and symlink this plugin to that repo. To do so: +To run this plugin locally in an existing project that has edge handlers, you'll need to install the netlify build +codebase locally and symlink this plugin to that repo. To do so: 1. Clone the build repo and install dependencies @@ -16,20 +19,24 @@ git clone git@github.com:netlify/build.git npm i ``` -2. Create a symlink from netlify-build/packages/build/node_modules/@netlify/plugin-edge-handlers towards the Edge handlers plugin's root directory. You can do this manually with `ln -s` or `npm link` +2. Create a symlink from netlify-build/packages/build/node_modules/@netlify/plugin-edge-handlers towards the Edge + handlers plugin's root directory. You can do this manually with `ln -s` or `npm link` -3. To verify that this step worked, cd /path/to/netlify-build/packages/build, then node -p 'require("@netlify/plugin-edge-handlers")' which should print the onPostBuild exported function +3. To verify that this step worked, cd /path/to/netlify-build/packages/build, then node -p + 'require("@netlify/plugin-edge-handlers")' which should print the onPostBuild exported function 4. Run the plugin locally in your project by typing in your project directory: + ``` /path/to/netlify-build/packages/build/src/core/bin.js ``` ## Testing + To run tests in this plugin, simply run: ``` npm run test ``` -This will start the integration tests located in the `integration-test` folder. \ No newline at end of file +This will start the integration tests located in the `integration-test` folder.