summaryrefslogtreecommitdiff
path: root/plugins/swiftpm/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'plugins/swiftpm/README.md')
-rw-r--r--plugins/swiftpm/README.md22
1 files changed, 22 insertions, 0 deletions
diff --git a/plugins/swiftpm/README.md b/plugins/swiftpm/README.md
new file mode 100644
index 000000000..07ca25651
--- /dev/null
+++ b/plugins/swiftpm/README.md
@@ -0,0 +1,22 @@
+# Swift Package Manager
+
+## Description
+
+This plugin provides a few utilities that make you faster on your daily work with the [Swift Package Manager](https://github.com/apple/swift-package-manager).
+
+To start using it, add the `swiftpm` plugin to your `plugins` array in `~/.zshrc`:
+
+```zsh
+plugins=(... swiftpm)
+```
+
+## Aliases
+
+| Alias | Description | Command |
+|-------|-------------------------------------|------------------------------------|
+| `spi` | Initialize a new package | `swift package init` |
+| `spf` | Fetch package dependencies | `swift package fetch` |
+| `spu` | Update package dependencies | `swift package update` |
+| `spx` | Generates an Xcode project | `swift package generate-xcodeproj` |
+| `sps` | Print the resolved dependency graph | `swift package show-dependencies` |
+| `spd` | Print parsed Package.swift as JSON | `swift package dump-package` |