Skip to content

Commit

Permalink
docs: Update for v5
Browse files Browse the repository at this point in the history
  • Loading branch information
khalwat committed Oct 8, 2024
1 parent 63fc22c commit 1b075ac
Show file tree
Hide file tree
Showing 3 changed files with 7 additions and 84 deletions.
75 changes: 2 additions & 73 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,76 +1,5 @@
# Recipe Changelog

## 4.0.9 - UNRELEASED
## 5.0.0 - UNRELEASED
### Added
* Add `phpstan` and `ecs` code linting
* Add `code-analysis.yaml` GitHub action

## 4.0.8 - 2024.01.14
### Added
* Automate release generation via GitHub action

### Changed
* Updated docs to use node 20 & a new sitemap plugin

### Fixed
* Fixes compatibility with FeedMe's base FieldInterface ([#69](https://github.com/nystudio107/craft-recipe/pull/69))

## 4.0.7 - 2023.02.23
### Fixed
* Fixed an issue where the Nutritional Information display didn't take into account the number of servings ([#66](https://github.com/nystudio107/craft-recipe/issues/66))

## 4.0.6 - 2023.02.22
### Fixed
* Fix API Requests ([#65](https://github.com/nystudio107/craft-recipe/pull/65))

## 4.0.5 - 2023.02.21
### Changed
* Refactored the docs buildchain to use a dynamic docker container setup
* Updated the docs to include instructions on how to do Multi-Component recipes

### Fixed
* Allow Recipe fields to work properly if they are embedded in a Matrix block ([#63](https://github.com/nystudio107/craft-recipe/issues/63))

## 4.0.4 - 2022.12.04
### Changed
* Fix the display of the Recipe icon logo on the Welcome screen

## 4.0.3 - 2022.12.01
### Changed
* Move to using `ServicesTrait` and add getter methods for services
* Switch to VitePress `^1.0.0-alpha.29` for the documentation
* Add `allow-plugins` to the `composer.json` to enable CI to work
* Wrap the fields in `<fieldset>` tags for semantic HTML & a11y
* Remove the odd Craft `modifiedAttributes` styling when a field value is changed ([#12403](https://github.com/craftcms/cms/issues/12403))

## 4.0.2 - 2022.05.10
### Fixed
* Fix array access on new type Int ([#59](https://github.com/nystudio107/craft-recipe/pull/59))

## 4.0.1 - 2022.05.09
### Fixed
* Fixed an issue where model properties were not converted from an array to an `int` before saving ((#57)[https://github.com/nystudio107/craft-recipe/issues/57])
* Fixed an issue with assets not showing up by removing `'enabledForSite': null,` from the `criteria`

## 4.0.0 - 2022.05.09
### Added
* Initial Craft CMS 4 release

### Fixed
* Fixed an issue where certain model properties were typed as `?array` when they should have been typed as `?int`, causing a type error to be thrown ((#57)[https://github.com/nystudio107/craft-recipe/issues/57])

## 4.0.0-beta.3 - 2022.04.13

### Fixed
* Fixed an issue where an exception would be thrown if the FeedMe beta plugin was installed ([#56](https://github.com/nystudio107/craft-recipe/issues/56))

## 4.0.0-beta.2 - 2022.03.14

### Fixed
* Fix issues with editable table fields, due to the change in default values for Craft 4

## 4.0.0-beta.1 - 2022.03.09

### Added

* Initial Craft CMS 4 compatibility
* Initial Craft CMS 5 release
10 changes: 3 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,14 @@
[![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/nystudio107/craft-recipe/badges/quality-score.png?b=v1)](https://scrutinizer-ci.com/g/nystudio107/craft-recipe/?branch=v1) [![Code Coverage](https://scrutinizer-ci.com/g/nystudio107/craft-recipe/badges/coverage.png?b=v1)](https://scrutinizer-ci.com/g/nystudio107/craft-recipe/?branch=v1) [![Build Status](https://scrutinizer-ci.com/g/nystudio107/craft-recipe/badges/build.png?b=v1)](https://scrutinizer-ci.com/g/nystudio107/craft-recipe/build-status/v1) [![Code Intelligence Status](https://scrutinizer-ci.com/g/nystudio107/craft-recipe/badges/code-intelligence.svg?b=v1)](https://scrutinizer-ci.com/code-intelligence)
[![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/nystudio107/craft-recipe/badges/quality-score.png?b=v5)](https://scrutinizer-ci.com/g/nystudio107/craft-recipe/?branch=v5) [![Code Coverage](https://scrutinizer-ci.com/g/nystudio107/craft-recipe/badges/coverage.png?b=v5)](https://scrutinizer-ci.com/g/nystudio107/craft-recipe/?branch=v5) [![Build Status](https://scrutinizer-ci.com/g/nystudio107/craft-recipe/badges/build.png?b=v5)](https://scrutinizer-ci.com/g/nystudio107/craft-recipe/build-status/v5) [![Code Intelligence Status](https://scrutinizer-ci.com/g/nystudio107/craft-recipe/badges/code-intelligence.svg?b=v5)](https://scrutinizer-ci.com/code-intelligence)

# Recipe plugin for Craft CMS 4.x
# Recipe plugin for Craft CMS 5.x

A comprehensive recipe FieldType for Craft CMS that includes metric/imperial conversion, portion calculation, and JSON-LD microdata support

![Screenshot](./docs/docs/resources/img/plugin-logo.png)

Related: [Recipe for Craft 2.x](https://github.com/nystudio107/recipe)

## Requirements

This plugin requires Craft CMS 4.0.0 or later.
This plugin requires Craft CMS 5.0.0 or later.

## Installation

Expand All @@ -21,8 +19,6 @@ To install Recipe, follow these steps:

You can also install Recipe via the **Plugin Store** in the Craft AdminCP.

Recipe works on Craft 4.x.

## Documentation

Click here -> [Recipe Documentation](https://nystudio107.com/plugins/recipe/documentation)
Expand Down
6 changes: 2 additions & 4 deletions docs/docs/index.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,14 @@
[![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/nystudio107/craft-recipe/badges/quality-score.png?b=v1)](https://scrutinizer-ci.com/g/nystudio107/craft-recipe/?branch=v1) [![Code Coverage](https://scrutinizer-ci.com/g/nystudio107/craft-recipe/badges/coverage.png?b=v1)](https://scrutinizer-ci.com/g/nystudio107/craft-recipe/?branch=v1) [![Build Status](https://scrutinizer-ci.com/g/nystudio107/craft-recipe/badges/build.png?b=v1)](https://scrutinizer-ci.com/g/nystudio107/craft-recipe/build-status/v1) [![Code Intelligence Status](https://scrutinizer-ci.com/g/nystudio107/craft-recipe/badges/code-intelligence.svg?b=v1)](https://scrutinizer-ci.com/code-intelligence)
[![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/nystudio107/craft-recipe/badges/quality-score.png?b=v5)](https://scrutinizer-ci.com/g/nystudio107/craft-recipe/?branch=v5) [![Code Coverage](https://scrutinizer-ci.com/g/nystudio107/craft-recipe/badges/coverage.png?b=v5)](https://scrutinizer-ci.com/g/nystudio107/craft-recipe/?branch=v5) [![Build Status](https://scrutinizer-ci.com/g/nystudio107/craft-recipe/badges/build.png?b=v5)](https://scrutinizer-ci.com/g/nystudio107/craft-recipe/build-status/v5) [![Code Intelligence Status](https://scrutinizer-ci.com/g/nystudio107/craft-recipe/badges/code-intelligence.svg?b=v5)](https://scrutinizer-ci.com/code-intelligence)

# Recipe plugin for Craft CMS

A comprehensive recipe FieldType for Craft CMS that includes metric/imperial conversion, portion calculation, and JSON-LD microdata support

![Screenshot](./resources/img/plugin-logo.png)

Related: [Recipe for Craft 2.x](https://github.com/nystudio107/recipe)

## Requirements

This plugin requires Craft CMS 3.0.0 or later or Craft CMS 4.0.0 or later.
This plugin requires Craft CMS 5.0.0

## Installation

Expand Down

0 comments on commit 1b075ac

Please sign in to comment.