Skip to content

Commit 25d1c68

Browse files
committed
DOCS: Improve readme
1 parent 0d24c7f commit 25d1c68

1 file changed

Lines changed: 6 additions & 5 deletions

File tree

README.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -9,20 +9,21 @@ Autogenerate php classes for NodeTypes with type safe property accessor methods
99
- The namespace of each NodeTypeObject is derived from the packaghe-key with added ``NodeTypes`
1010
- The className of a NodeTypeObject is defined by the last part of the NodeTypeName with postfix `NodeTypeObject`
1111

12-
## Precondtions
12+
## Preconditions
1313

1414
The following preconditions have to be met for a package to use NodeTypeObjects.
1515

16-
- The Package registers a PSR4 Namespace for NodeTypes in the.composer.json that points to the NodeTypes folder
17-
- The pattern `*NodeTypeObject.php` hast to be added to `.gitignore` to avoid committing the generated files.
18-
- The commands `nodetypeobjects:build` and `nodetypeobjects:clean` have to be integrated into build processes and watchers
16+
- The php namespace of the package is directly derived from the Neos package key. As is the default and best practice.
17+
- The Package registers a PSR4 Namespace for `NodeTypes` in the `composer.json` that points to the `NodeTypes` folder.
18+
- The pattern `*NodeTypeObject.php` is added to `.gitignore` to avoid committing the generated files.
19+
- The commands `nodetypeobjects:build` and `nodetypeobjects:clean` are integrated into build processes and watchers
1920

2021
## Usage
2122

2223
The package defines the following cli commands
2324

2425
- `./flow nodetypeobjects:build Vendor.Site` : regenerate all NodeTypeObject in the given package.
25-
- `./flow nodetypeobjects:clean Vendor.Site` : remove all NodeTypeObject in the given package.
26+
- `./flow nodetypeobjects:clean Vendor.Site` : remove all NodeTypeObject in the given package. This will also remove orphaned NodeObjects.
2627

2728
## Installation
2829

0 commit comments

Comments
 (0)