Skip to content

Commit

Permalink
Apply suggestions from code review
Browse files Browse the repository at this point in the history
Co-authored-by: David Glick <david@glicksoftware.com>
  • Loading branch information
sneridagh and davisagli authored Oct 25, 2024
1 parent e73496c commit 09eb7c4
Showing 1 changed file with 8 additions and 8 deletions.
16 changes: 8 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -123,9 +123,9 @@ The theme package has them declared as `peerDependencies`.

### Project-based setups (`yarn`)

If your project relies in a boilerplate generated by `@plone/generator-volto`, then it's project-based.
In this case, it uses `yarn` as package manager.
Because how `yarn` works, it won't install these dependencies for you, as they are declared as `peerDependencies`.
If your project relies on a boilerplate generated by `@plone/generator-volto`, then it's project-based.
In this case, it uses `yarn` as a package manager.
Because of how `yarn` works, it won't install these dependencies for you, as they are declared as `peerDependencies`.
This is because the theme won't have to force you to use any specific add-on version, and avoids package hoisting issues in `yarn` installations.
If this is your case, it is recommended that your project or policy add-on `package.json` include the aforementioned add-ons as `dependencies`.

Expand Down Expand Up @@ -160,7 +160,7 @@ In your project or policy add-on `package.json` you should declare all of them a

Make sure your policy add-on is the last one, as you would want that its configuration has priority over all the others. Make sure also that `@kitconcept/volto-light-theme` is the one before your policy add-on.

If you don't want to install one or several of them, you can not to declare them in the `addons` key.
If you don't want to install one or several of them, you can leave them out of the `addons` property.

Declare the theme in your project `package.json`:

Expand All @@ -170,10 +170,10 @@ Declare the theme in your project `package.json`:

### Cookieplone-based setups (new `pnpm` based setups)

If you are using one of the new setups project-less, based in Cookieplone, then it uses `pnpm`, and it will install the `peerDependencies` by default (recommended setup).
In this case, you won't have to install them, `pnpm` will do it for you, using the recommended versions used in `peerDependencies`.
If you are using one of the new project-less setups based on Cookieplone, then it uses `pnpm`, and it will install the `peerDependencies` by default (recommended setup).
In this case, you won't have to install them; `pnpm` will do it for you, using the recommended versions used in `peerDependencies`.

In a project-less based setup, using Cookieplone, declare both the addons and the theme in your setup's `volto.config.js`:
In a project-less based setup, using Cookieplone, declare both the addons and the theme in `volto.config.js`:

```js
const addons = [
Expand All @@ -195,7 +195,7 @@ module.exports = {
};
```

As alternative, you can specify your project add-ons in your policy add-on for better portability, but at least your policy add-on should be in `volto.config.js`.
As an alternative, you can specify your project add-ons in your policy add-on for better portability, but at least your policy add-on should be in `volto.config.js`.

## Feature Flags

Expand Down

0 comments on commit 09eb7c4

Please sign in to comment.