diff --git a/Package.swift b/Package.swift index 770209a..710954c 100644 --- a/Package.swift +++ b/Package.swift @@ -12,8 +12,8 @@ let package = Package( targets: [ .binaryTarget( name: "scheme-generator", - url: "https://github.com/mackoj/SchemeGenerator/releases/download/0.3.0/scheme-generator.artifactbundle.zip", - checksum: "80767ae49f38b46ed23e76dca668599a7d2b4b86cb823842967391ffb04b131f" + url: "https://github.com/mackoj/SchemeGenerator/releases/download/0.4.0/scheme-generator.artifactbundle.zip", + checksum: "e5e6d3d66419d2d09215c572fd11432f151889ff307c46410c5a2bc1fbaadf97" ), .plugin( name: "SchemeGeneratorPlugin", diff --git a/README.md b/README.md index 4c6ff19..0f392ee 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,27 @@ # SchemeGeneratorPlugin -A description of this package. +This plugin allow to generate schemes automatically. +This is very usefull when using TCA or any SPM based project. + +It works only for mac using apple silicon. + +## Usage + +To use it you have to set a configuration file at the root of your project named `scheme_generator.yaml`. +This file contain. +```yaml +# Where the schemes will be saved +schemesDirectory: "" + +# Remove schemes that are not in the Package.swift anymore +removeNotGeneratedSchemes: true + +# Force the overwrite of already present scheme +overwriteAlreadyGeneratedSchemes: false + +# This allow to have more info in the console for debug purpose +verbose: false +``` + + +Have fun