Files
SpiffWorkflow/doc/index.rst
2024-04-17 14:17:54 -04:00

63 lines
2.2 KiB
ReStructuredText

.. image:: https://travis-ci.com/sartography/SpiffWorkflow.svg?branch=master
:target: https://travis-ci.org/sartography/SpiffWorkflow
.. image:: https://github.com/sartography/SpiffWorkflow/actions/workflows/tests.yaml/badge.svg
:target: https://github.com/sartography/SpiffWorkflow/actions/workflows/tests.yaml
.. image:: https://img.shields.io/github/stars/sartography/SpiffWorkflow.svg
:target: https://github.com/sartography/SpiffWorkflow/stargazers
.. image:: https://img.shields.io/github/license/sartography/SpiffWorkflow.svg
:target: https://github.com/sartography/SpiffWorkflow/blob/master/COPYING
What is SpiffWorkflow?
======================
.. image:: images/logo.png
:align: center
:target: https://www.spiffworkflow.org
**SpiffWorkflow is a library that provides a flexible workflow execution environment.**
SpiffWorkflow is the workflow library underlying `Spiff Arena <https://github.com/sartography/spiff-arena>`_.
It consists of a generic core library, with modules supporting parsing and execution of BPMN diagrams that extend
this core.
Extensive documentation about BPMN and how SpiffWorkflow interprets it, as well as information about custom extensions
implemented in the :code:`spiff` package can be found in the
`Spiff Arena documentation <https://spiff-arena.readthedocs.io/en/latest/>`_. If you are not familiar with BPMN, you
should start there. If you are looking for a full-fledged BPMN application, you can start and end there. This
documentation will focus on the library itself and is geared towards developers who are building their own
applications.
Please visit `SpiffWorkflow.org <https://www.spiffworkflow.org>`_ for
additional articles, videos, and tutorials about SpiffWorkflow and its
related projects including SpiffArena, Service Connectors, and BPMN.js
extensions.
License
-------
Spiff Workflow is published under the terms of the
`GNU Lesser General Public License (LGPL) Version 3 <https://www.gnu.org/licenses/lgpl-3.0.txt>`_.
Support
-------
You can find us on `our Discord Channel <https://discord.gg/BYHcc7PpUC>`_
Commercial support for SpiffWorkflow is available from
`Sartography <https://sartography.com>`_
Contents
--------
.. toctree::
:maxdepth: 2
concepts
modules
bpmn/index
core/index