From 400659dcec0d6d46b3501b5aa835b8c9294845ac Mon Sep 17 00:00:00 2001 From: Shahriar <31452340+ShahriarKh@users.noreply.github.com> Date: Fri, 14 Jul 2023 15:05:57 +0330 Subject: [PATCH 1/3] Update README.md --- README.md | 18 ++++++++++++++++-- 1 file changed, 16 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 406287a..951a6c7 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,17 @@ -# Strapi plugin content-type-explorer +# 🗺 Contnet-Type Explorer -A quick description of content-type-explorer. +Content-Type Explorer is a Strapi plugin that visualizes your contnet types and their relationships like an ERD (Entity Relationship Diagram). + +![image](https://github.com/ShahriarKh/strapi-content-type-explorer/assets/31452340/0cac9494-5dc3-43ad-a1b2-d46a1c3ea26c) + +![image](https://github.com/ShahriarKh/strapi-content-type-explorer/assets/31452340/5f7abe98-f626-4838-a1fb-5f6e72e6ec15) + + +## Installation +```bash +npm i strapi-content-type-explorer +``` + +## Options +- **Default Fields**: +- ** From 36446a9241076c9916a9b74f3530c1fe378636bb Mon Sep 17 00:00:00 2001 From: Shahriar <31452340+ShahriarKh@users.noreply.github.com> Date: Fri, 14 Jul 2023 19:45:03 +0330 Subject: [PATCH 2/3] Update README.md --- README.md | 16 +++++++++++----- 1 file changed, 11 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 951a6c7..7967cfe 100644 --- a/README.md +++ b/README.md @@ -1,17 +1,23 @@ # 🗺 Contnet-Type Explorer -Content-Type Explorer is a Strapi plugin that visualizes your contnet types and their relationships like an ERD (Entity Relationship Diagram). +Content-Type Explorer is a Strapi plugin that visualizes your content types and their relationships like an ERD (Entity Relationship Diagram). ![image](https://github.com/ShahriarKh/strapi-content-type-explorer/assets/31452340/0cac9494-5dc3-43ad-a1b2-d46a1c3ea26c) ![image](https://github.com/ShahriarKh/strapi-content-type-explorer/assets/31452340/5f7abe98-f626-4838-a1fb-5f6e72e6ec15) -## Installation +## ⌨️ Installation ```bash npm i strapi-content-type-explorer ``` -## Options -- **Default Fields**: -- ** +## ⚙️ Options +- **Field Data Types**: +- **Field Icons**: +- **Default Fields**: `createdBy`, `createdAt`, `updatedAt` +- **Relational Fields Only** +- **admin:: Types** +- **plugin:: Types** +- **Edges** +- **Snap to Grid** From f7c97ace7341bd0f29035dcb40edf1fa33739a30 Mon Sep 17 00:00:00 2001 From: Shahriar <31452340+ShahriarKh@users.noreply.github.com> Date: Fri, 14 Jul 2023 19:56:41 +0330 Subject: [PATCH 3/3] Update README.md --- README.md | 24 ++++++++++++++++-------- 1 file changed, 16 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 7967cfe..7b6de18 100644 --- a/README.md +++ b/README.md @@ -13,11 +13,19 @@ npm i strapi-content-type-explorer ``` ## ⚙️ Options -- **Field Data Types**: -- **Field Icons**: -- **Default Fields**: `createdBy`, `createdAt`, `updatedAt` -- **Relational Fields Only** -- **admin:: Types** -- **plugin:: Types** -- **Edges** -- **Snap to Grid** +- Field Data Types +- Field Icons +- Default Fields: toggle `createdBy`, `createdAt`, `updatedAt` +- Relational Fields Only +- `admin::` Types +- `plugin::` Types +- Edges +- Snap to Grid +- Backgorund Pattern +- Edge Type + +## 🧭 Tips +If you encounter lags while dragging boxes, try changing edge types. "Smart" edges cause performance issues (this should be fixed in future releases) + +## 🚀 Collaboration +Have a question or found a bug? Feel free to open an issue. Wanna contribute and improve the plugin? PRs are welcome!