From 431fca39b8ea7ed55d2e6aafede28145009a8727 Mon Sep 17 00:00:00 2001
From: pacien
Date: Sat, 24 Jul 2021 11:12:53 +0200
Subject: specs: add demo project specifications

---
 demo-project-specs.md | 43 +++++++++++++++++++++++++++++++++++++++++++
 readme.md             |  2 +-
 2 files changed, 44 insertions(+), 1 deletion(-)
 create mode 100644 demo-project-specs.md

diff --git a/demo-project-specs.md b/demo-project-specs.md
new file mode 100644
index 0000000..e3bfbeb
--- /dev/null
+++ b/demo-project-specs.md
@@ -0,0 +1,43 @@
+---
+title: >
+  UGE / L2 / Intro to relational databases / Python project prototype /
+  Money transfer platform specification
+
+author: Pacien TRAN-GIRARD
+date: 2021-07-24
+...
+
+
+# Project description
+
+The goal is to create a platform on which users can send money to each others.
+
+
+## Accounts
+
+Unauthenticated visitors can to either create a new account or log in into an
+existing one using their username and the matching password.
+
+### Balance
+
+Each account has a balance, which must remain non-negative at all times.
+
+### Transaction log
+
+Users can see a log of all of the financial transactions which involved them.
+
+
+## Operations
+
+### Deposit and withdrawal
+
+Users can deposit and withdraw an arbitrary amount of money to and from their
+account. Both operations are free.
+
+### Money transfer
+
+Users can send money between each others, referred to by their respective
+usernames.
+
+Each transaction between users has a fee of 10% of the transferred amount.
+
diff --git a/readme.md b/readme.md
index 5839c20..b75e14a 100644
--- a/readme.md
+++ b/readme.md
@@ -12,7 +12,7 @@ assignment as both students and the teaching staff are already familiar with
 the former from preceding units.
 
 To showcase Python as a platform suitable for this purpose, a small demo
-project specified will be implemented.
+project specified in `./demo-project-specs.md` will be implemented.
 
 
 ## Copyright and licensing
-- 
cgit v1.2.3