From 512d44806958edf46f4287dc8ff61052f24ad7b3 Mon Sep 17 00:00:00 2001
From: Sebastian Gniazdowski <sgniazdowski@gmail.com>
Date: Mon, 8 Jul 2019 17:46:16 +0200
Subject: [PATCH] Initial commit (.gitignore, LICENSE, README.md)

---
 .gitignore | 16 ++++++++++++++++
 LICENSE    | 22 ++++++++++++++++++++++
 README.md  | 29 +++++++++++++++++++++++++++++
 3 files changed, 67 insertions(+)
 create mode 100644 .gitignore
 create mode 100644 LICENSE
 create mode 100644 README.md

diff --git a/.gitignore b/.gitignore
new file mode 100644
index 0000000..bf93698
--- /dev/null
+++ b/.gitignore
@@ -0,0 +1,16 @@
+
+### Vim
+# Swap
+[._]*.s[a-v][a-z]
+[._]*.sw[a-p]
+[._]s[a-v][a-z]
+[._]sw[a-p]
+
+# Session
+Session.vim
+
+# Temporary
+.netrwhist
+*~
+# Auto-generated tag files
+tags
diff --git a/LICENSE b/LICENSE
new file mode 100644
index 0000000..396d783
--- /dev/null
+++ b/LICENSE
@@ -0,0 +1,22 @@
+This software is licensed under MIT.
+
+MIT License
+-----------
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..468eb18
--- /dev/null
+++ b/README.md
@@ -0,0 +1,29 @@
+# Introduction
+
+A z-plugin (i.e. a plugin for the [Zplugin](https://github.com/zdharma/zplugin)) that
+allows Zpluugin to clone submodules when installing a plugin or snippet.
+
+It adds `submod''` ice to Zplugin with a following syntax:
+
+```zsh
+submod'{user}/{plugin} -> {output directory}; ...'
+```
+
+So the example command using the z-plugin and its ice is e.g.
+
+```zsh
+# Load the zsh-autosuggestions plugin via Prezto module autosuggestions
+zplugin ice svn submod'zsh-users/zsh-autosuggestions -> external'
+zplugin snippet PZT::modules/autosuggestions
+```
+
+# Installation
+
+Simply load as a plugin. This will install the z-plugin within Zplugin:
+
+```zsh
+zplugin light zdharma/z-p-submods
+```
+
+<!-- vim:tw=85
+-->