From 4de510778b6e55a2238374834d00b03726da76d4 Mon Sep 17 00:00:00 2001
From: Laria Carolin Chabowski <laria@laria.me>
Date: Tue, 3 Oct 2017 14:59:45 +0200
Subject: Documentation

---
 storage/local/local.go | 7 +++++++
 1 file changed, 7 insertions(+)

(limited to 'storage/local')

diff --git a/storage/local/local.go b/storage/local/local.go
index 7dc59cb..ae39eb5 100644
--- a/storage/local/local.go
+++ b/storage/local/local.go
@@ -20,6 +20,13 @@ func objectDir(id objects.ObjectId) string {
 	return joinPath(string(id.Algo), hex.EncodeToString(id.Sum[0:1]))
 }
 
+// LocalStorage is a storage implementation that saves your objects on your local filesystem.
+//
+// Example config:
+//
+//     [storage.local_test]
+//     method="local"
+//     path="~/.local/share/petrific" # Save the objects here
 type LocalStorage struct {
 	Path  string
 	index storage.Index
-- 
cgit v1.2.3-70-g09d2