diff options
| author | Daniel Friesel <derf@derf.homelinux.org> | 2009-07-03 12:34:49 +0200 |
|---|---|---|
| committer | Daniel Friesel <derf@derf.homelinux.org> | 2009-07-03 12:34:49 +0200 |
| commit | dfb67ebe4dd1c8f1cddad8a4858dae7b5abc63ef (patch) | |
| tree | 655c6747b806f0b7ea27cbd60ca3ef48137d92fe | |
| parent | e8960614b0f8223f7eaa0b1773b9759fa5cd68be (diff) | |
documentation: Note the Simplestore restrictions, added MOTIVATION section
| -rw-r--r-- | lib/Simplestore.pm | 10 |
1 files changed, 10 insertions, 0 deletions
diff --git a/lib/Simplestore.pm b/lib/Simplestore.pm index 222aab1..c12bb7b 100644 --- a/lib/Simplestore.pm +++ b/lib/Simplestore.pm @@ -76,6 +76,9 @@ Simplestore - simple storage format for hash refs B<Simplestore> is a perl library to store hashes in a very simple, easy-to-parse file format. +Note that it can only store simple hashes with string/digit values. +References or any other complex stuff is not supported. + =head1 FUNCTIONS =over @@ -94,6 +97,13 @@ save I<hashref> in I<storefile>. Returns nothing. =back +=head1 MOTIVATION + +B<Simplestore> aims to provide a common, simple format to store data. +The format is extremely easy to parse in almost all languages, even C or Shell, +thus Simplestore should offer a good way to exchange non-complex data between +apps of all kinds. + =head1 COPYRIGHT Copyright (C) 2009 by Daniel Friesel. |