Update readme

Innovgame · Jan 18, 2023 · 2933c2f · 2933c2f
1 parent f146eb5
commit 2933c2f
Show file tree

Hide file tree

Showing 6 changed files with 24 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -6,6 +6,29 @@ Chili3D is a fast, web-based 3D CAD program that works in any modern browser. Bu
 
 Chili3D is still in the very early stages of development. APIs can and will change (now is the time to make suggestions!). Important features are missing. Documentation is sparse. Please don't build any serious projects in Chili3D unless you are prepared to be broken by API changes constantly.
 
+## Features
+
+### Snap and tracking
+
+Can snap to circle center, endpoint, midpoint, intersection and perpendicular point. Tracks the x, y and z axes as well as any polar axis in the working plane.
+![snap](screenshots/snap.gif)
+
+### Group
+
+![group](screenshots/group.gif)
+
+### Properties
+
+![group](screenshots/property.gif)
+
+### Undo redo
+
+![undo](screenshots/undo.gif)
+
+### Multilingual
+
+Support for both English and Simplified Chinese languages.
+
 ## How to Use
 
 This project requires Node.js to be installed.

diff --git a/package.json b/package.json
@@ -15,7 +15,7 @@
         "pre-commit": "npx lint-staged"
     },
     "lint-staged": {
-        "*": [
+        "*.{ts,js,css,json,md}": [
             "prettier --write"
         ]
     },

diff --git a/screenshots/group.gif b/screenshots/group.gif
diff --git a/screenshots/property.gif b/screenshots/property.gif
diff --git a/screenshots/snap.gif b/screenshots/snap.gif
diff --git a/screenshots/undo.gif b/screenshots/undo.gif