From d9c60809dbeb0fa184e4468d31274bf642445235 Mon Sep 17 00:00:00 2001 From: Daniel Atwood Date: Tue, 7 Apr 2020 16:41:25 +0200 Subject: [PATCH] Update a bit the readme to be more precise about what this project does. --- README.md | 22 ++++++++++++++++++++-- 1 file changed, 20 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 07ebee2..e7290b6 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,31 @@ # Copanier -Copanier is a software to make grouped orders. +Copanier is a software to make grouped orders. It's generally used by small groups +who want to buy food supplies directly from producers, without requiring each +individual to see each producer. It helps people to order a set of defined products, and provide a few helpers to ease the life of everyone involved :-) +## How does it work? + +1. A new delivery is created ; +2. Producers and products are created in the software (or copied from a past delivery) ; +3. (Optional : prices are checked with the producers to be sure they are still okay) ; +4. Individuals place their orders for their groups ; +5. Referents ask their producers for the products and pay them ; +6. There is a delivery, after which a dispatching of who has to pay whom is automatically done. + +## Features + +- Handles groups of people (useful for people sharing a house, for instance) ; +- Handles multiple producers in one delivery ; +- Intelligent dispatching of payments, without any central bank account ; +- Support for shipping fees ; + ## Fork -This project is a continuation of the work by +This project is a continuation of the work done by [Alexis](https://framagit.org/almet/copanier), itself took from the work Yohan did in the first place.