Add quickstart example usage to module docstring (#423)

abelsiqueira · Sep 5, 2024 · 82bd740 · 82bd740
1 parent 7281bcb
commit 82bd740
Showing 1 changed file with 12 additions and 0 deletions.
diff --git a/src/BestieTemplate.jl b/src/BestieTemplate.jl
@@ -6,6 +6,18 @@ to use it from Julia.
 
 The main functions are: [`generate`](@ref), [`apply`](@ref), and [`update`](@ref).
 
+To create a new package using BestieTemplate run
+
+```julia
+julia> BestieTemplate.generate("path/to/YourNewPackage.jl")
+```
+
+To apply the template to an existing package
+
+```julia
+julia> BestieTemplate.apply("path/to/YourExistingPackage.jl")
+```
+
 Check the documentation: https://abelsiqueira.com/BestieTemplate.jl
 """
 module BestieTemplate