aboutsummaryrefslogtreecommitdiffstats
path: root/_examples/README.md
diff options
context:
space:
mode:
authorMáximo Cuadros <mcuadros@gmail.com>2017-01-31 23:09:28 +0100
committerMáximo Cuadros <mcuadros@gmail.com>2017-01-31 23:09:52 +0100
commita6197bd8c459c7d10717bd9486c17f6c8b3f7f88 (patch)
tree63180ec210c66fda317c87197d2f6bab508406b6 /_examples/README.md
parent2308066c28d3cbbfb472fb634c3e10a1c7786cfc (diff)
downloadgo-git-a6197bd8c459c7d10717bd9486c17f6c8b3f7f88.tar.gz
documentation changes
Diffstat (limited to '_examples/README.md')
-rw-r--r--_examples/README.md14
1 files changed, 14 insertions, 0 deletions
diff --git a/_examples/README.md b/_examples/README.md
new file mode 100644
index 0000000..334664f
--- /dev/null
+++ b/_examples/README.md
@@ -0,0 +1,14 @@
+# go-git: examples
+
+Here you can find a list of annotated _go-git_ examples:
+
+### Basic
+- [showcase](showcase/main.go) - A small showcase of the capabilities of _go-git_
+- [open](open/main.go) - Opening a existing repository cloned by _git_
+- [clone](clone/main.go) - Cloning a repository
+- [remotes](remotes/main.go) - Working with remotes: adding, removing, etc
+- [progress](progress/main.go) - Priting the progress information from the sideband
+
+### Advanced
+- [custom_http](custom_http/main.go) - Replacing the HTTP client using a custom one
+- [storage](storage/main.go) - Implementing a custom storage system