Skip to content
This repository has been archived by the owner on Sep 16, 2022. It is now read-only.

Commit

Permalink
Merge pull request #1 from DivineDominion/patch-1
Browse files Browse the repository at this point in the history
Add links and short usage description to README
  • Loading branch information
polpielladev authored Sep 9, 2022
2 parents eb4bcac + ed13722 commit 8782d0b
Showing 1 changed file with 21 additions and 1 deletion.
22 changes: 21 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,23 @@
# SourceryPlugins

A description of this package.
Use [Sourcery](https://github.com/krzysztofzablocki/Sourcery) as a code generator in your project as a Swift package's command plugin.

See: [Blog post explaining how this works[(https://www.polpiella.dev/sourcery-swift-package-command-plugin/)

## Usage

### Command line

To verify the plugin can be found by SwiftPM, use:

$ swift package --list

To run the code generator, you need to allow changes to the project with the `--allow-writing-to-package-directory` flag:

$ swift package --allow-writing-to-package-directory sourcery-code-generation

### Xcode

Inside a project/package that uses this command plugin, right-click the project and select "SourceryCommand" from the "SourceryPlugins" menu group.

(Requires Xcode 14)

0 comments on commit 8782d0b

Please sign in to comment.