From da89cc7d6adef662b17f63333fd4340e6aa146bc Mon Sep 17 00:00:00 2001
From: DamSenViet <26016342+DamSenViet@users.noreply.github.com>
Date: Mon, 9 Nov 2020 01:29:09 -0800
Subject: [PATCH] core: added docs differences warning

---
 docs/examples/index.md | 8 ++++++++
 1 file changed, 8 insertions(+)

diff --git a/docs/examples/index.md b/docs/examples/index.md
index ff6d2d9..1080e53 100644
--- a/docs/examples/index.md
+++ b/docs/examples/index.md
@@ -182,3 +182,11 @@ img.qr-code {
 }
 ```
 
+## Differences between acpatterns-js and acpatterns.com
+
+If you read in a file and the fields aren't the same between acnl files
+generated between acpatterns.com and acpatterns-js, this library uses field
+limitations based on in-game limits, whereas the internal library at
+acpatterns.com uses file-format based limits.
+
+e.g. ACNL only allows villager names to be 8 characters, but the file-format allows for 9 (not counting null termination). This library obeys the 8 character limit set by the developers of the game for safety.
\ No newline at end of file