Add quickstart

ericphanson · Jan 31, 2025 · e00ad92 · e00ad92
1 parent cf97b9f
commit e00ad92
Showing 1 changed file with 9 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -4,6 +4,15 @@
 [![Build Status](https://github.com/ericphanson/ExplicitImports.jl/actions/workflows/CI.yml/badge.svg?branch=main)](https://github.com/ericphanson/ExplicitImports.jl/actions/workflows/CI.yml?query=branch%3Amain)
 [![Coverage](https://codecov.io/gh/ericphanson/ExplicitImports.jl/branch/main/graph/badge.svg)](https://codecov.io/gh/ericphanson/ExplicitImports.jl)
 
+## Quickstart
+
+Install ExplicitImports.jl with `using Pkg; Pkg.add("ExplicitImports")`, then run
+```julia
+using MyPackage # the package you want to analyze
+using ExplicitImports
+print_explicit_imports(MyPackage)
+```
+
 ## Summary
 
 ExplicitImports.jl helps detect implicit imports and mitigate issues with the alternatives (explicit imports and qualified accesses).