From c4d5b232f0358ca6c7f6c2639b8fc19dc10cc34c Mon Sep 17 00:00:00 2001
From: Daniel Friesel <derf@derf.homelinux.org>
Date: Sat, 4 Jul 2009 12:06:20 +0200
Subject: Added some documentation about the storage format

---
 lib/Simplestore.pm | 7 +++++++
 1 file changed, 7 insertions(+)

diff --git a/lib/Simplestore.pm b/lib/Simplestore.pm
index c450937..7d0834a 100644
--- a/lib/Simplestore.pm
+++ b/lib/Simplestore.pm
@@ -97,6 +97,13 @@ save I<hashref> in I<storefile>. Returns nothing.
 
 =back
 
+=head1 STORAGE FORMAT
+
+The store file contains key-value-pairs, each of them separated by a newline,
+The key and value are separated by a single tab.
+If a value contains newlines, they will be printed, but the next line(s) will be
+prefixed by the key. For a little example, see SYNOPSIS.
+
 =head1 MOTIVATION
 
 B<Simplestore> aims to provide a common, simple format to store data.
-- 
cgit v1.2.3