From 7936469d2073ceb869e423eb6eeadd1a55df82e6 Mon Sep 17 00:00:00 2001
From: Micah Galizia <micahgalizia@gmail.com>
Date: Mon, 2 Sep 2024 17:20:19 -0400
Subject: [PATCH] chore: update docs

---
 CONTRIBUTING.md        |  7 +++++++
 README.md              |  3 +++
 packages/api/README.md | 14 ++++++++++++++
 3 files changed, 24 insertions(+)

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 5427699..664c40e 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -1,3 +1,10 @@
+# General Contribution Guidelines
+
+TBD, but here are some things we should read:
+
+
+* [Data Model](packages/api/README.md#data-model)
+
 # Upgrading OpenTelemetry
 
 Dependencies seem to be problematic -- I once got into a situation where `@opentelemetry/api` version `@1.9.0` was in my package.json but `1.8.0` was getting installed as the dependency of the other otel dependencies, causing conflicts.  Cleaning up the packages seemed to help:
diff --git a/README.md b/README.md
index dafeea8..5b70c8d 100644
--- a/README.md
+++ b/README.md
@@ -26,3 +26,6 @@ And then everything should be available on http://localhost:8080/.
 | ------------ | ---------------- |
 |[![Installing tbltp](https://img.youtube.com/vi/_ADo3CKNORU/default.jpg)](https://youtu.be/_ADo3CKNORU)|[![tbltp editor](https://img.youtube.com/vi/-1dxslmHktc/default.jpg)](https://youtu.be/-1dxslmHktc)|
 
+## Development
+
+See [Contributing](CONTRIBUTING.md)
\ No newline at end of file
diff --git a/packages/api/README.md b/packages/api/README.md
index b1ef7c1..3e85b60 100644
--- a/packages/api/README.md
+++ b/packages/api/README.md
@@ -56,6 +56,12 @@ TABLESTATE ||--|| SCENE : shows
 
 GAME ||--o{ SCENE : contains
 
+SCENE ||--o{ ENTITY : contains
+
+ENTITY ||--o| TOKEN : draws
+
+COMBAT ||--o{ ENTITY : orders
+
 GM {
   guid id
 }
@@ -76,6 +82,14 @@ TABLESTATE {
 GAME {
   string name
 }
+
+ENTITY {
+  boolean visible
+}
+
+TOKEN {
+  sting url
+}
 ```
 
 ## File Layout