add a README with a screenshot

ccdirectlink3 · Dec 22, 2020 · 982496d · 982496d
1 parent da1fbf6
commit 982496d
Show file tree

Hide file tree

Showing 3 changed files with 8 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -0,0 +1,7 @@
+# Teleport Anywhere!
+
+Teleport to any map/room in an area or a dungeon simply by clicking it in the map menu.
+
+**Unimportant notice:** This mod is, of course, a cheat, and is intended only for debugging and mod development purposes. But it's not like I'm gonna prevent you from using it for other purposes :P
+
+![screenshot](screenshot.png)
diff --git a/package.json b/package.json
@@ -2,7 +2,7 @@
   "name": "teleport-anywhere",
   "version": "0.1.0",
   "ccmodHumanName": "Teleport Anywhere!",
-  "description": "Teleport to any map/room in an area simply by clicking it in the map menu",
+  "description": "Teleport to any map/room in an area or a dungeon simply by clicking it in the map menu",
   "license": "CC0-1.0",
   "homepage": "https://github.com/dmitmel/crosscode-teleport-anywhere",
   "module": true,

diff --git a/screenshot.png b/screenshot.png