From 8186df2d2c2c664287d53e3de82063aaedfc1b79 Mon Sep 17 00:00:00 2001
From: Matt Brockman <mattbrockman@gmail.com>
Date: Sat, 16 Jan 2021 17:59:37 -0800
Subject: [PATCH] Added stats to readme

---
 README.md | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 9d831b8..57b3c87 100644
--- a/README.md
+++ b/README.md
@@ -61,7 +61,8 @@ See https://github.com/latitudegames/Scripting/blob/master/examples/addSimpleInv
   * `state.disableRandomSkill` disables the user from learning random skills in the screen
   * `state.skillPoints` sets the number of skill points a player has available.
 See https://github.com/latitudegames/Scripting/blob/master/examples/skills.js for examples.
-
+* `state.stats` is a dictionary stats: {stats:{..., statName:{level, cost}}, statPoints}. This opens the stats overlay in adventure menu allowing players to allocate `statPoints` at `cost`.
+See https://github.com/latitudegames/Scripting/blob/master/examples/stats.js for examples.
 
 * You can set any variable on state to store and modify adventures throughout an adventure.