summaryrefslogtreecommitdiff
path: root/plugins/swift-pm/README.md
diff options
context:
space:
mode:
authorThomas Paul Mann <hi@thomaspaulmann.com>2016-11-28 21:08:34 +0100
committerMarc Cornellà <marc.cornella@live.com>2016-11-28 21:08:34 +0100
commit037764acc366bae0dc0f01c221c7a23ef04d3c83 (patch)
treef2e4081e90f3bd71c44834688caf5b0f1214f99c /plugins/swift-pm/README.md
parent9d43dc88bbc313921661c8b699e78550a2d86708 (diff)
downloadzsh-037764acc366bae0dc0f01c221c7a23ef04d3c83.tar.gz
zsh-037764acc366bae0dc0f01c221c7a23ef04d3c83.tar.bz2
zsh-037764acc366bae0dc0f01c221c7a23ef04d3c83.zip
Add plugin for Swift Package Manager (#5670)
* Add plugin for Swift Package Manager * swift-package-manager: Rename plugin to 'swift-pm'
Diffstat (limited to 'plugins/swift-pm/README.md')
-rw-r--r--plugins/swift-pm/README.md22
1 files changed, 22 insertions, 0 deletions
diff --git a/plugins/swift-pm/README.md b/plugins/swift-pm/README.md
new file mode 100644
index 000000000..8e6a0d5c4
--- /dev/null
+++ b/plugins/swift-pm/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 `swift-pm` plugin to your `plugins` array in `~/.zshrc`:
+
+```zsh
+plugins=(... swift-pm)
+```
+
+## 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` |