Browse Source

Merge pull request #77 from abronan/enhance_documentation

Update README.md and add more documentation under the 'docs' folder
Alexandre Beslic 9 years ago
parent
commit
1f587cf86c
1 changed files with 0 additions and 61 deletions
  1. 0 61
      libnetwork/internal/kvstore/kvstore_manage.go

+ 0 - 61
libnetwork/internal/kvstore/kvstore_manage.go

@@ -1,64 +1,3 @@
-// Package libkv provides a Go native library to store metadata.
-//
-// The goal of libkv is to abstract common store operations for multiple
-// Key/Value backends and offer the same experience no matter which one of the
-// backend you want to use.
-//
-// For example, you can use it to store your metadata or for service discovery to
-// register machines and endpoints inside your cluster.
-//
-// As of now, `libkv` offers support for `Consul`, `Etcd` and `Zookeeper`.
-//
-// ## Example of usage
-//
-// ### Create a new store and use Put/Get
-//
-//
-//     package main
-//
-//     import (
-//     	"fmt"
-//     	"time"
-//
-//     	"github.com/docker/libkv"
-//     	"github.com/docker/libkv/store"
-//     	log "github.com/Sirupsen/logrus"
-//     )
-//
-//     func main() {
-//     	client := "localhost:8500"
-//
-//     	// Initialize a new store with consul
-//     	kv, err := libkv.NewStore(
-//     		store.CONSUL, // or "consul"
-//     		[]string{client},
-//     		&store.Config{
-//     			ConnectionTimeout: 10*time.Second,
-//     		},
-//     	)
-//     	if err != nil {
-//     		log.Fatal("Cannot create store consul")
-//     	}
-//
-//     	key := "foo"
-//     	err = kv.Put(key, []byte("bar"), nil)
-//     	if err != nil {
-//     		log.Error("Error trying to put value at key `", key, "`")
-//     	}
-//
-//     	pair, err := kv.Get(key)
-//     	if err != nil {
-//     		log.Error("Error trying accessing value at key `", key, "`")
-//     	}
-//
-//     	log.Info("value: ", string(pair.Value))
-//     }
-//
-// ##Copyright and license
-//
-// Code and documentation copyright 2015 Docker, inc. Code released under the
-// Apache 2.0 license. Docs released under Creative commons.
-//
 package libkv
 
 import (