lunit-io / insight-viewer

medical image viewer component for React
https://insight-viewer.lunit.io
MIT License
34 stars 6 forks source link

VIEWER-161 / 라이브러리 README 업데이트 #408

Closed LTakhyunKim closed 1 year ago

LTakhyunKim commented 1 year ago

📝 Description

insight-viewer README 에 Annotation, Dicom Viewer, Interaction 에 대한 기본적인 예시를 추가했습니다. (많은 사용이 예상되는 기능을 선정하여 작성했습니다.)

기본 예시는 React 기본 세팅에서 라이브러리 설치 후 App 에서 바로 실행할 수 있도록 작성했습니다.

더불어 annotation, viewport, insight-viewer 라이브러리의 README 도 목적에 대한 코멘트를 추가하여 업데이트 했습니다.

✔️ PR Type

What kind of change does this PR introduce?

🎯 Current behavior

각 라이브러리 README 는 nx 기본 README 로 구성되어 있습니다.

Issue Number: https://lunit.atlassian.net/browse/VIEWER-161

🚀 New behavior

insight-viewer 라이브러리 root README 에 기본 예제를 추가했으며, 세부 라이브러리의 README 에도 목적에 대한 코멘트를 추가했습니다.

💣 Is this a breaking change?

github-actions[bot] commented 1 year ago

Coverage report

St.:grey_question:
Category Percentage Covered / Total
🟢 Statements 93.02% 80/86
🟢 Branches 94.55% 52/55
🟡 Functions 77.78% 21/27
🟢 Lines 92.31% 72/78

Test suite run success

66 tests passing in 9 suites.

Report generated by 🧪jest coverage report action from 9a862b2ffcc138c497442d162705000662c0ec28

github-actions[bot] commented 1 year ago

preview: https://insight-viewer--pr-408.f.lunit.io/