Skip to content

Add "HIPAA-safe Quickstart" and clarify --exclude usage #287

@rdlasco

Description

@rdlasco

Please add a short “HIPAA-safe Quickstart” section to the README so new users can try de-identification without using real PHI. The note should point to the deid-data package (synthetic DICOM files), show how to run deid --help (or python -m deid --help), include a very small Python example that opens one synthetic file, and explain that --exclude accepts a comma-separated list (for example: build,.git,venv). This is a documentation-only change; I’m happy to open the pull request. The goal is to reduce the chance of handling real PHI by mistake and make first-time setup clearer.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions