diff --git a/README.md b/README.md index 406287a..7b6de18 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,31 @@ -# 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 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 +```bash +npm i strapi-content-type-explorer +``` + +## ⚙️ Options +- 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!