📝 Insert placeholder version 3 schema change notice

README.md

@@ -1,4 +1,5 @@
 # charactercontroller
+
 A first person character controller for the Three.js graphics library
 
 ![GitHub Lint Workflow Status](https://img.shields.io/github/workflow/status/ma1ted/charactercontroller/CI?label=Lint)
@@ -11,9 +12,11 @@ A first person character controller for the Three.js graphics library
 ## [Demo](https://controller.malted.dev)
 
 ## Installation
+
 `npm install charactercontroller`
 
 ## Usage
+
 ```javascript
 import CharacterController from "charactercontroller";
 
@@ -22,64 +25,72 @@ import CharacterController from "charactercontroller";
 const controller = new CharacterController(scene, options);
 
 function animate() {
-  requestAnimationFrame(animate);
-  // ...
-  controller.update();
-  renderer.render(scene, controller.camera);
+	requestAnimationFrame(animate);
+	// ...
+	controller.update();
+	renderer.render(scene, controller.camera);
 }
 ```
-* `scene`
-  + An instance of `THREE.Scene` that the Character Controller is to become a child of.
 
-* `options`
-  + An object defining options for the Character Controller. The valid fields are described below
+- `scene`
+
+  - An instance of `THREE.Scene` that the Character Controller is to become a child of.
+
+- `options`
+  - An object defining options for the Character Controller. The valid fields are described below
 
 ## Constructor Options
-* `walkSpeed`
-  + The rate at which the controller is translated in the scene in response to player inputs, when the sprint key (left shift) **is not** being pressed.
-  + Default: `5`
-* `sprintSpeed`
-  + The rate at which the controller is translated in the scene in response to player inputs, when the sprint key (left shift) **is** being pressed.
-  + Default: `10`
-* `floorDistance`
-  + How far above a surface the controller can get before stopping falling.
-  + Could be interpreted as the height of the player.
-  + Default: `1`
-* `gravity`
-  + How quickly the controller is pulled down when there is no surface beneath it.
-  + Default: `-9.81`
-* `jumpPower`
-  + With how much force the controller is projected upwards when a jump is initiated.
-  + Default: `5`
-* `sensitivity`
-  + `x`
+
+- `walkSpeed`
+  - The rate at which the controller is translated in the scene in response to player inputs, when the sprint key (left shift) **is not** being pressed.
+  - Default: `5`
+- `sprintSpeed`
+  - The rate at which the controller is translated in the scene in response to player inputs, when the sprint key (left shift) **is** being pressed.
+  - Default: `10`
+- `floorDistance`
+  - How far above a surface the controller can get before stopping falling.
+  - Could be interpreted as the height of the player.
+  - Default: `1`
+- `gravity`
+  - How quickly the controller is pulled down when there is no surface beneath it.
+  - Default: `-9.81`
+- `jumpPower`
+  - With how much force the controller is projected upwards when a jump is initiated.
+  - Default: `5`
+- `sensitivity`
+  - `x`
     - How much the camera should move in response to the player moving the mouse left and right.
     - Default: `0.1`
-  + `y`
+  - `y`
     - How much the camera should move in response to the player moving the mouse up and down.
     - Default: `0.1`
-* `lookLimit`
-  + `down`
+- `lookLimit`
+  - `down`
     - The angle in degrees that the camera's `x` rotation should be clamped to when looking down
     - Default: `0`
-  + `up`
+  - `up`
     - The angle in degrees that the camera's `x` rotation should be clamped to when looking up
     - Default: `180`
-* `cameraFov`
-  + The field of view of the camera attatched to the character controller.
-  + Default: `75`
-* `inputs`
-  + The `KeyboardEvent.code`s that control the character controller. An array of `code`s are used to support multiple keys controlling the same actions; primarily for accessability reasons.
-  + `forwards`
-    - Default: [`KeyW`, `ArrowUp`]
-  + `backwards`
-    - Default: [`KeyS`, `ArrowDown`]
-  + `left`
-    - Default: [`KeyA`, `ArrowLeft`]
-  + `right`
-    - Default: [`KeyD`, `ArrowRight`]
-  + `jump`
-    - Default: [`Space`]
-  + `sprint`
-    - Default: [`ShiftLeft`, `ShiftRight`]
-
+- `cameraFov`
+  - The field of view of the camera attatched to the character controller.
+  - Default: `75`
+- `inputMappings`
+
+  - The input mapping schema has changed in version 3. The docs are currently being rewitten to reflect this. In the meantime, look at the `inputMappings` property in `/src/index.js` for the new schema.
+
+  <!--
+    - The `KeyboardEvent.code`s that control the character controller. An array of `code`s are used to support multiple keys controlling the same actions; primarily for accessability reasons.
+  
+    + `forwards`
+      - Default: [`KeyW`, `ArrowUp`]
+    + `backwards`
+      - Default: [`KeyS`, `ArrowDown`]
+    + `left`
+      - Default: [`KeyA`, `ArrowLeft`]
+    + `right`
+      - Default: [`KeyD`, `ArrowRight`]
+    + `jump`
+      - Default: [`Space`]
+    + `sprint`
+      - Default: [`ShiftLeft`, `ShiftRight`]
+  -- >