summaryrefslogtreecommitdiff
path: root/plugins/git-lfs/README.md
diff options
context:
space:
mode:
authorDuc Nguyen <vietduc01100001@gmail.com>2020-10-09 17:35:13 +0700
committerGitHub <noreply@github.com>2020-10-09 12:35:13 +0200
commit8ad9b315a389c741d93aece3ed6eae6b6829f951 (patch)
tree7c1726214325e9fff7a98b6db71f1006d1b6fa96 /plugins/git-lfs/README.md
parent58ff4e1d2e6a81ea97a05b142c28a931a9924b70 (diff)
downloadzsh-8ad9b315a389c741d93aece3ed6eae6b6829f951.tar.gz
zsh-8ad9b315a389c741d93aece3ed6eae6b6829f951.tar.bz2
zsh-8ad9b315a389c741d93aece3ed6eae6b6829f951.zip
Add git-lfs plugin (#9077)
Diffstat (limited to 'plugins/git-lfs/README.md')
-rw-r--r--plugins/git-lfs/README.md24
1 files changed, 24 insertions, 0 deletions
diff --git a/plugins/git-lfs/README.md b/plugins/git-lfs/README.md
new file mode 100644
index 000000000..1222b2767
--- /dev/null
+++ b/plugins/git-lfs/README.md
@@ -0,0 +1,24 @@
+# git lfs plugin
+
+The git lfs plugin provides [aliases](#aliases) and [functions](#functions) for [git-lfs](https://github.com/git-lfs/git-lfs).
+
+To use it, add `git-lfs` to the plugins array in your zshrc file:
+
+```zsh
+plugins=(... git-lfs)
+```
+
+## Aliases
+
+| Alias | Command |
+| :------- | :---------------------------------- |
+| `glfsi` | `git lfs install` |
+| `glfst` | `git lfs track` |
+| `glfsls` | `git lfs ls-files` |
+| `glfsmi` | `git lfs migrate import --include=` |
+
+## Functions
+
+| Function | Command |
+| :------- | :---------------------------------------------- |
+| `gplfs` | `git lfs push origin "$(current_branch)" --all` |