Skip to content

Commit 3053ec9

Browse files
authored
fix(docs): align readme with plugins installation flow
I’m proposing a small update to this README. The goals: - Ensure that users learn how to install through the Netlify UI - Align it with some recent changes we’ve made to our [file-based installation instructions](https://docs.netlify.com/configure-builds/build-plugins/#file-based-installation) for Build Plugins
1 parent 651acdf commit 3053ec9

File tree

1 file changed

+9
-1
lines changed

1 file changed

+9
-1
lines changed

README.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,9 @@ Automatically generate a sitemap for your site after it finishes building in Net
44

55
## Installation
66

7-
To install, add the following lines to your `netlify.toml` file:
7+
You can install this plugin in the Netlify UI from this [direct in-app installation link](https://app.netlify.com/plugins/@netlify/plugin-sitemap/install) or from the [Plugins directory](https://app.netlify.com/plugins).
8+
9+
To use file-based installation, add the following lines to your `netlify.toml` file:
810

911
```toml
1012
[[plugins]]
@@ -13,6 +15,12 @@ package = "@netlify/plugin-sitemap"
1315

1416
Note: The `[[plugins]]` line is required for each plugin, even if you have other plugins in your `netlify.toml` file already.
1517

18+
To complete file-based installation, from your project's base directory, use npm, yarn, or any other Node.js package manager to add this plugin to devDependencies in `package.json`.
19+
20+
```
21+
npm install -D @netlify/plugin-sitemap
22+
```
23+
1624
## Configuration
1725

1826
By default, the plugin generates a sitemap based on the `publish` directory configured in your site build settings or `netlify.toml`.

0 commit comments

Comments
 (0)