aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md32
1 files changed, 32 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..e70b91f
--- /dev/null
+++ b/README.md
@@ -0,0 +1,32 @@
+# Debt
+A debt recorder, which helps to remember who owns you money
+
+
+## Database
+
+```sql
+CREATE TABLE Agents (
+ id INTEGER PRIMARY KEY,
+ name TEXT NOT NULL UNIQUE
+ )
+```
+
+```sql
+CREATE TABLE Registers (
+ id INTEGER PRIMARY KEY,
+ agent_id INTEGER,
+ register_date INTEGER NOT NULL,
+ amount INTEGER NOT NULL,
+ note TEXT,
+ FOREIGN KEY(agent_id) REFERENCES Agents(id)
+ )
+```
+
+## Client
+
+```
+Usage:
+ debt action [options]
+```
+
+## Server
Feel free to download, copy and edit any repo