aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorDavid Robillard <d@drobilla.net>2021-03-28 13:42:35 -0400
committerDavid Robillard <d@drobilla.net>2022-01-28 21:57:29 -0500
commitf8a59da9c492b7df38f53ba96505313e931d76cc (patch)
tree5bf1e44e67f8662894a37fbc84d770585f5957dd /README.md
parentac0ac05ccf96dee4406db8bdd4d098d3de61c01f (diff)
downloadserd-f8a59da9c492b7df38f53ba96505313e931d76cc.tar.gz
serd-f8a59da9c492b7df38f53ba96505313e931d76cc.tar.bz2
serd-f8a59da9c492b7df38f53ba96505313e931d76cc.zip
Add high-level documentation
Diffstat (limited to 'README.md')
-rw-r--r--README.md20
1 files changed, 13 insertions, 7 deletions
diff --git a/README.md b/README.md
index c99b320a..568da8e0 100644
--- a/README.md
+++ b/README.md
@@ -1,10 +1,10 @@
Serd
====
-Serd is a lightweight C library for RDF syntax which supports reading and
-writing [Turtle][], [TriG][], [NTriples][], and [NQuads][]. Serd is suitable
-for performance-critical or resource-limited applications, such as serialising
-very large data sets or embedded systems.
+Serd is a lightweight C library for working with RDF data in [Turtle][],
+[NTriples][], [NQuads][], and [TriG][] formats. It is particularly suitable
+for performance-critical or resource-limited applications, such as rewriting
+very large data sets, or working on restricted platforms.
Features
--------
@@ -48,9 +48,15 @@ a constant amount of memory (a single page) for all input sizes.
Documentation
-------------
- * [API reference (single page)](https://drobilla.gitlab.io/serd/c/singlehtml)
- * [API reference (paginated)](https://drobilla.gitlab.io/serd/c/html)
- * [`serdi` man page](https://drobilla.gitlab.io/serd/man/serdi.html)
+ * Overview and reference documentation:
+ * [Paginated HTML](https://drobilla.gitlab.io/serd/c/html)
+ * [Single page HTML](https://drobilla.gitlab.io/serd/c/singlehtml)
+ * [EPUB](https://drobilla.gitlab.io/serd/c/epub/Serd-1.0.1.epub)
+ * Man pages:
+ * [`serd-filter`](https://drobilla.gitlab.io/serd/man/serd-filter.html)
+ * [`serd-pipe`](https://drobilla.gitlab.io/serd/man/serd-pipe.html)
+ * [`serd-sort`](https://drobilla.gitlab.io/serd/man/serd-sort.html)
+ * [`serd-validate`](https://drobilla.gitlab.io/serd/man/serd-validate.html)
-- David Robillard <d@drobilla.net>