From b519a6a9e0b21772964257cb89b525659436c98f Mon Sep 17 00:00:00 2001 From: Hugo Osvaldo Barrera Date: Sat, 21 May 2022 18:30:41 +0200 Subject: [PATCH] Improve introduction docs --- docs/index.rst | 13 ++++++++++--- 1 file changed, 10 insertions(+), 3 deletions(-) diff --git a/docs/index.rst b/docs/index.rst index fbedb38c0..c21511b3e 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -4,15 +4,22 @@ django-payments This library is a Django app for handling payments with a few different payment providers. -It includes support for a few different payment providers using a unified API. +When using ``django-payments``, you integrate with the Python API the library +exposes, and the library handles all the communication with the payment +processor. The most obvious use case is implementing online payments on +e-commerce websites, though other unusual cases exist. + +Because it provides a common API for different providers, it once one provider +is working, it's trivial to add support for others onto a same codebase. General design -------------- A single abstract model is included: :class:`payments.models.BasePayment`. Applications using this library need to subclass it and implement a few specific -method. It is also possible to domain-specific fields that the may be required -(e.g.: foreign keys to a purchase, or user). +method (see the class docs for details). Subclasses can also include their own +additional fields that may be required for payments (e.g.: a foreign key to a +purchase, or a user). This is up to the developer. Contents: