From 891af1fc001f2f2da951dcee181c247083c6a40b Mon Sep 17 00:00:00 2001
From: Frederick Muriuki Muriithi
Date: Tue, 9 Jul 2024 11:21:45 -0500
Subject: Provide sample JSON file and update instruction in docs

The documentation for generating a transformation of a JSON file into
a Terse RDF Triple Language (Turtle) form was incomplete. This commit
provides a sample JSON file that can be used to demonstrate the
working of the code.

Reviewed-by: Munyoki Kilyungi <me@bonfacemunyoki.com>
---
 .gitignore      | 1 +
 README.md       | 6 ++++--
 etc/sample.json | 8 ++++++++
 3 files changed, 13 insertions(+), 2 deletions(-)
 create mode 100644 etc/sample.json

diff --git a/.gitignore b/.gitignore
index cd9b92c..1219888 100644
--- a/.gitignore
+++ b/.gitignore
@@ -1,2 +1,3 @@
 *.go
 /**/*~
+/tmp/*
diff --git a/README.md b/README.md
index 8c94ccd..06dc82d 100644
--- a/README.md
+++ b/README.md
@@ -28,12 +28,14 @@ $ make
 or for a container
 
 ```shell
-mkdir test
+mkdir ./tmp
 guix shell -C --network --share=/run/mysqld/ --manifest=manifest.scm
 export GUILE_LOAD_PATH=.:$GUILE_LOAD_PATH
-guile json-dump.scm conn.scm test/
+guile json-dump.scm etc/sample.json tmp/
 ```
 
+That reads the `etc/sample.json` file included in this repository and converts it to an RDF representation that is stored in a file `./tmp/sampledata.ttl`.
+
 
 ## Set up connection parameters
 
diff --git a/etc/sample.json b/etc/sample.json
new file mode 100644
index 0000000..b32e24c
--- /dev/null
+++ b/etc/sample.json
@@ -0,0 +1,8 @@
+{
+    "metadata": {
+        "name": "some-metadata-item-name",
+        "displayName": "the-item-display-name",
+        "createdBy": "Frederick M. Muriithi"
+        "why": "to-demo-usage-of-system-and-for-documentation"
+    }
+}
-- 
cgit v1.2.3