Skip to content
This repository was archived by the owner on May 2, 2022. It is now read-only.

Commit 882bc9b

Browse files
authored
Apply Prettier to README.md (#82)
1 parent ca33b32 commit 882bc9b

File tree

1 file changed

+13
-6
lines changed

1 file changed

+13
-6
lines changed

README.md

Lines changed: 13 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,15 @@
11
# Netlify Plugin Edge Handlers
22

3-
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.
3+
This plugin is used to bundle Edge Handlers for deployment. It is included in the list of core plugins in Netlify's
4+
build, meaning that any handler under the `./edge-handlers` directory will be bundled by Netlify's buildbot.
45

56
## Usage
67

7-
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.
8+
This plugin is already integrated into Netlify's build process and will not need to be included in your project for Edge
9+
Handlers to work.
810

9-
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:
11+
To run this plugin locally in an existing project that has edge handlers, you'll need to install the netlify build
12+
codebase locally and symlink this plugin to that repo. To do so:
1013

1114
1. Clone the build repo and install dependencies
1215

@@ -16,20 +19,24 @@ git clone [email protected]:netlify/build.git
1619
npm i
1720
```
1821

19-
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`
22+
2. Create a symlink from netlify-build/packages/build/node_modules/@netlify/plugin-edge-handlers towards the Edge
23+
handlers plugin's root directory. You can do this manually with `ln -s` or `npm link`
2024

21-
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
25+
3. To verify that this step worked, cd /path/to/netlify-build/packages/build, then node -p
26+
'require("@netlify/plugin-edge-handlers")' which should print the onPostBuild exported function
2227

2328
4. Run the plugin locally in your project by typing in your project directory:
29+
2430
```
2531
/path/to/netlify-build/packages/build/src/core/bin.js
2632
```
2733

2834
## Testing
35+
2936
To run tests in this plugin, simply run:
3037

3138
```
3239
npm run test
3340
```
3441

35-
This will start the integration tests located in the `integration-test` folder.
42+
This will start the integration tests located in the `integration-test` folder.

0 commit comments

Comments
 (0)