diff options
| author | David Robillard <d@drobilla.net> | 2021-03-16 19:05:52 -0400 |
|---|---|---|
| committer | David Robillard <d@drobilla.net> | 2021-03-16 19:08:37 -0400 |
| commit | a56c9d4c789c2294b3c5a4fb7b1e39b8b75e4eec (patch) | |
| tree | fb6fc95bfcb9b85f468e91ef28e1ce6e6b1fec43 | |
| parent | abce3c01977c4a56952dac20de14076f86d58d74 (diff) | |
| download | sratom-a56c9d4c789c2294b3c5a4fb7b1e39b8b75e4eec.tar.gz sratom-a56c9d4c789c2294b3c5a4fb7b1e39b8b75e4eec.tar.bz2 sratom-a56c9d4c789c2294b3c5a4fb7b1e39b8b75e4eec.zip | |
WIP: Improve documentation
| -rw-r--r-- | README.md | 8 | ||||
| -rw-r--r-- | doc/summary.rst | 6 |
2 files changed, 9 insertions, 5 deletions
@@ -1,9 +1,11 @@ Sratom ====== -Sratom is a small library for serialising LV2 atoms to and from RDF, for -converting between binary and text or storing in a model. For more -information, see <http://drobilla.net/software/sratom>. +Sratom is a small library for reading and writing LV2 atoms in RDF, for +representing them as strings or storing them in a data model. Sratom is useful +for representing LV2 atoms in a portable and human-readable form. + +For more information, see <http://drobilla.net/software/sratom>. More information about LV2 atoms can be found at <http://lv2plug.in/ns/ext/atom> diff --git a/doc/summary.rst b/doc/summary.rst index 89d87e9..7e28f6e 100644 --- a/doc/summary.rst +++ b/doc/summary.rst @@ -1,4 +1,6 @@ -Sratom is a small library for serialising `LV2 atoms`_ to and from RDF, -for converting between binary and text or storing in a model. +Sratom is a small library for reading and writing `LV2 atoms`_ in RDF, +for representing them as strings or storing them in a data model. +Sratom is useful for representing LV2 atoms in a portable and human-readable form, +in, for example, saved files, network protocols, or logs. .. _LV2 atoms: http://lv2plug.in/ns/ext/atom |