Skip to content

Commit

Permalink
chore: update README
Browse files Browse the repository at this point in the history
  • Loading branch information
bartkownacki authored and bartkownacki committed Aug 23, 2023
1 parent c862fda commit b5dd1d7
Showing 1 changed file with 14 additions and 3 deletions.
17 changes: 14 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -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-<timestamp>.html` will be generated in your root directory.

## Building

Expand Down

0 comments on commit b5dd1d7

Please sign in to comment.