aboutsummaryrefslogtreecommitdiffstats
path: root/_examples/remotes
diff options
context:
space:
mode:
authorMáximo Cuadros <mcuadros@gmail.com>2017-03-01 17:39:56 +0100
committerGitHub <noreply@github.com>2017-03-01 17:39:56 +0100
commitd105e15d91e7553d9d40d6e9fffe0a5008cf8afe (patch)
tree3fbafa48a960575f9419392c5626de7951a6eda9 /_examples/remotes
parentf0affc5579ec907c3092b125ff35b0359b8c4e49 (diff)
parentd24ea4984ce6871ea24eb376325082602c766295 (diff)
downloadgo-git-d105e15d91e7553d9d40d6e9fffe0a5008cf8afe.tar.gz
Merge pull request #293 from ajnavarro/improvement/examples
_examples: improve documentation (fix #238)
Diffstat (limited to '_examples/remotes')
-rw-r--r--_examples/remotes/main.go7
1 files changed, 7 insertions, 0 deletions
diff --git a/_examples/remotes/main.go b/_examples/remotes/main.go
index 9537fea..06ffdd1 100644
--- a/_examples/remotes/main.go
+++ b/_examples/remotes/main.go
@@ -10,6 +10,13 @@ import (
"srcd.works/go-git.v4/storage/memory"
)
+// Example of how to:
+// - Create a new in-memory repository
+// - Create a new remote named "example"
+// - List remotes and print them
+// - Pull using the new remote "example"
+// - Iterate the references again, but only showing hash references, not symbolic ones
+// - Remove remote "example"
func main() {
// Create a new repository
Info("git init")