From b5dd1d7c3a7f9fb43fc262c7e345bc89a9c81113 Mon Sep 17 00:00:00 2001 From: Bart Kownacki <107057105+bartkownacki@users.noreply.github.com> Date: Wed, 23 Aug 2023 10:05:03 +0200 Subject: [PATCH] chore: update README --- README.md | 17 ++++++++++++++--- 1 file changed, 14 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 5b152d7..ed32450 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,21 @@ -# Dynamic-Doctor 💉 +# Dynamic-Doctor 🩺 -![Team Doctor 💉](https://github.com/dynamic-labs/DynamicDoctor/assets/107057105/f315c93c-2d75-424f-8436-d19a960f5d53) +![Dynamic-Doctor 🩺](https://github.com/dynamic-labs/dynamic-doctor/assets/107057105/af7b4146-6c09-42d1-8578-2287645b5f84) ## Use case -You can use this package to verify your Dynamic SDK setup and generate report which can be reviewed by Dynamic Team. +You can use this package to verify your Dynamic SDK setup and generate a report that can be reviewed by the Dynamic Team. + +## How to use + +Here are the steps to follow to check your project setup: + +1. Go to root directory of your project. +2. Run `npx dynamic-doctor run` + +That's all! + +You will see a list of issues found and a file `dynamic-doctor-report-.html` will be generated in your root directory. ## Building