chore(*): update README

Author: neki-dev

README.md

@@ -41,11 +41,11 @@ const pathfinding = new Pathfinding(
 
 - `config` - _Pathfinding configuration_
 
-| Prop           | Description                                                                      | Default |
-| -------------- | -------------------------------------------------------------------------------- | ------- |
-| loopRate       | Pause before executing the next task after all previous ones have been completed | 100 ms  |
-| maxStackSize   | Max recursive depth to handle task in one tick                                   | 128     |
-| resourceLimits | Worker resource limits                                                           | -       |
+| Prop            | Description                                           | Default |
+| --------------- | ----------------------------------------------------- | ------- |
+| taskFindingRate | Delay to handle next task after all previous are done | 100 ms  |
+| maxStackSize    | Max recursive depth to handle task in one tick        | 128     |
+| resourceLimits  | Worker resource limits                                | -       |
 
 ### ⚡️ Terminate worker thread
 
@@ -112,6 +112,11 @@ const idTask = layer.findPath(
 
 - `callback` - _Callback with result_
 
+| Prop   | Description         | Type            |
+| ------ | ------------------- | --------------- |
+| path   | Path to target cell | Array<{ x, y }> |
+| weight | Total path weight   | number          |
+
 ### ⚡️ Cancel pathfinder task
 
 ```ts

dist/task/types.d.ts

@@ -21,7 +21,7 @@ export type PathfindingTaskConfig = {
  */
 export type PathfindingTaskResult = {
     /**
-     * Path from starting cell to ending cell
+     * Path to target cell
      * Will be null if path is not found
      */
     path: PathfindingPoint[] | null;

package.json

@@ -1,7 +1,7 @@
 {
   "name": "pathfinding-worker",
   "description": "Fast node.js pathfinding on workers for grid-based games",
-  "version": "2.7.0",
+  "version": "2.7.1",
   "keywords": [
     "astar",
     "dijkstra",

src/task/types.ts

@@ -25,7 +25,7 @@ export type PathfindingTaskConfig = {
  */
 export type PathfindingTaskResult = {
   /**
-   * Path from starting cell to ending cell
+   * Path to target cell
    * Will be null if path is not found
    */
   path: PathfindingPoint[] | null;