Skip to content

Commit

Permalink
Readme update
Browse files Browse the repository at this point in the history
  • Loading branch information
adamcharnock committed Nov 30, 2024
1 parent d62d283 commit 4e2cd51
Showing 1 changed file with 9 additions and 17 deletions.
26 changes: 9 additions & 17 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,15 @@ django-hordak

**Double entry bookkeeping in Django.**

Django Hordak provides a `simple model layer`_ for a double-entry accounting
system. The intention is not to provide a full-featured app, but rather
to provide a reliable foundation on which to build such apps.
Django Hordak is the core functionality of a double entry accounting system.
It provides thoroughly tested core models with relational integrity constrains to ensure consistency.

Hordak also includes a basic accounting interface. This should allow you to get up-and-running quickly.
However, the expectation is that you will either heavily build on this example or use one of the interfaces detailed below.

Tested under Python: 3.8, 3.9, 3.10, 3.11, 3.12
Django: 4.2, 5.0
Tested under Python: 3.8, 3.9, 3.10, 3.11, 3.12. Django: 4.2, 5.0

`Adam Charnock`_ **is available for freelance/contract work.**

.. image:: https://img.shields.io/pypi/v/django-hordak.svg
:target: https://badge.fury.io/py/django-hordak
Expand All @@ -28,19 +31,8 @@ Documentation

Documentation can be found at: http://django-hordak.readthedocs.io/

Related Projects
----------------

Django Hordak is the core functionality of a double entry accounting system.
It provides thoroughly tested core models with relational integrity constrains
to ensure consistency.

Interfaces which build on Hordak include:

* `battlecat`_ – General purpose accounting interface (work in progress)
* `swiftwind`_ – Accounting for communal households (work in progress)


.. _swiftwind: https://github.com/adamcharnock/swiftwind/
.. _simple model layer: https://github.com/adamcharnock/django-hordak/blob/master/hordak/models/core.py
.. _battlecat: https://github.com/adamcharnock/battlecat
.. _Adam Charnock: https://adamcharnock.com

0 comments on commit 4e2cd51

Please sign in to comment.