From 7ba69771a6937e0c31d57ac994103f89556806c3 Mon Sep 17 00:00:00 2001 From: TehThanos <36815670+TehThanos@users.noreply.github.com> Date: Fri, 28 Aug 2020 22:38:32 +0300 Subject: [PATCH] Changed wrong naming convention in README.md (#603) The README said to use camel case names for new components while it should be pascal case. --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 2ca00b05..32e09d59 100644 --- a/README.md +++ b/README.md @@ -59,7 +59,7 @@ This project is based on ES5. Some ES2015 features are used but most of them are 1. Create the component file in `src/js/game/components/.js` 2. Create a component class (e.g. `MyFancyComponent`) which `extends Component` -3. Create a `static getId()` method which should return the `CamelCaseName` without component (e.g. `MyFancy`) +3. Create a `static getId()` method which should return the `PascalCaseName` without component (e.g. `MyFancy`) 4. If any data needs to be persisted, create a `static getSchema()` which should return the properties to be saved (See other components) 5. Add a constructor. **The constructor must be called with optional parameters only!** `new MyFancyComponent({})` should always work. 6. Add any props you need in the constructor.