zf

commit 2f30c0c11264f0222a640e394fc8c4e2385931d3
parent 61b8df6c6a0006c57aff55fa0aad787fe9ff03ef
Author: srfsh <dev@srf.sh>
Date:   Tue, 19 Jul 2022 15:37:55 +0300

Merge branch 'master' of github.com:dyne/zenflows

Diffstat:
M
.gitignore
 | 
2
++
M
README.md
 | 
51
+++++++++++++++++++++++++++++----------------------
A
docs/zenflows_rea_logo.png
 | 
0

3 files changed, 31 insertions(+), 22 deletions(-)
diff --git a/.gitignore b/.gitignore
@@ -99,6 +99,8 @@
 !/docs/
 /docs/*
 !/docs/*.md
+!/docs/*.png
+!/docs/*.jpg
 
 # devops stuff
 !/.dockerignore
diff --git a/README.md b/README.md
@@ -1,15 +1,26 @@
-<h1 align="center">
-  Zenflows - GraphQL implementation of the [Valueflows](https://www.valueflo.ws) vocabulary</br>
-  <sub></sub>
-</h1>
+# Zenflows - Valueflows REA GraphDB
 
-<p align="center">
-  <a href="https://dyne.org">
-    <img src="https://img.shields.io/badge/%3C%2F%3E%20with%20%E2%9D%A4%20by-Dyne.org-blue.svg" alt="Dyne.org">
-  </a>
-</p>
+![Zenflows logo](docs/zenflows_rea_logo.png)
+
+Zenflows is a tool to leverage commons-based peer production by
+documenting and monitoring the life cycle of products. The goal is
+that of enabling a federated network of organizations to bundle,
+systematize and share data, information and knowledge about physical
+artifacts.
+
+[![software by Dyne.org](https://files.dyne.org/software_by_dyne.png)](http://www.dyne.org)
+
+## Features
+
+- Most validations are provable (and sealed by means of cryptography) using [Zenroom](https://zenroom.org) as core crypto component, including support for advanced Digital Product Passport schemes like 
+[REFLOW Portable Crypto Functions](https://medium.com/think-do-tank/reflow-crypto-material-passports-for-the-circular-economy-d75b3aa63678).
+
+- The [Valueflows](https://valueflo.ws) vocabulary is adopted to govern a [Resource Event Agent](https://en.wikipedia.org/wiki/Resources,_Events,_Agents) accounting model and facilitate the development and execution of business logics built on top of it.
+
+- The [PosgreSQL](https://postgresql.org) database backend is used as battle-tested data-storage solution well compatible with established enterprise standards in system administration, on top of it a GraphQL interface is developed based on the well performant [Elixir](https://elixir-lang.org) language framework.
+
+Zenflows is a software component of the [INTERFACER project](https://www.interfacerproject.eu).
 
-<br><br>
 
 <h4 align="center">
   <a href="#-quick-start">🎮 Quick start</a>
@@ -34,18 +45,6 @@
 </h4>
 
 
-Abstract description like: 🚧 Zenflows is a software in **ALPHA
-stage** and is part of the [INTERFACER project](https://www.interfacerproject.eu).
-
-Zenflows is a tool to leverage commons-based peer production by
-documenting and monitoring the life cycle of products. The goal is
-that of enabling a federated network of organizations to bundle,
-systematize and share data, information and knowledge about physical
-artifacts.
-
-Zenflows features [Zenroom](https://zenroom.org) as core crypto
-component to implement advanced Digital Product Passport schemes using
-[REFLOW Portable Crypto Functions](https://medium.com/think-do-tank/reflow-crypto-material-passports-for-the-circular-economy-d75b3aa63678).
 
 
 <details id="toc">
@@ -85,12 +84,16 @@ To start using Zenflows
 ***
 ## 🔧 Configuration
 
+🚧 TODO
+
 **[🔝 back to top](#toc)**
 
 ***
 
 ## 📋 Testing
 
+🚧 TODO
+
 **[🔝 back to top](#toc)**
 
 ***
@@ -106,6 +109,8 @@ To start using Zenflows
 ***
 ## 🐛 Troubleshooting & debugging
 
+🚧 TODO
+
 **[🔝 back to top](#toc)**
 
 ***
@@ -129,6 +134,8 @@ This project is receiving funding from the European Regional Development Fund (E
 ***
 ## 🌐 Links
 
+https://interfacerproject.eu
+
 https://dyne.org/
 
 https://reflowproject.eu
diff --git a/docs/zenflows_rea_logo.png b/docs/zenflows_rea_logo.png
Binary files differ.