From 01440f7d19648b8eedc4d366a0b3adbe80734d2e Mon Sep 17 00:00:00 2001
From: David Douard <david.douard@sdfa3.org>
Date: Thu, 4 Oct 2018 15:24:02 +0200
Subject: [PATCH] docs: add a basic README file

---
 README.md | 18 ++++++++++++++++++
 1 file changed, 18 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 00000000..f26f274c
--- /dev/null
+++ b/README.md
@@ -0,0 +1,18 @@
+swh-model
+=========
+
+Implementation of the Data model of the Software Heritage project, used to
+archive source code artifacts.
+
+This module defines the notion of Persistent Identifier (PID) and provides
+tools to compute them:
+
+```sh
+   $ swh-identify fork.c kmod.c sched/deadline.c
+   swh:1:cnt:2e391c754ae730bd2d8520c2ab497c403220c6e3    fork.c
+   swh:1:cnt:0277d1216f80ae1adeed84a686ed34c9b2931fc2    kmod.c
+   swh:1:cnt:57b939c81bce5d06fa587df8915f05affbe22b82    sched/deadline.c
+
+   $ swh-identify --no-filename /usr/src/linux/kernel/
+   swh:1:dir:f9f858a48d663b3809c9e2f336412717496202ab
+```
-- 
GitLab