updating the readme.

This commit is contained in:
Dan 2023-01-05 14:35:33 -05:00
parent 7edc5b6c1f
commit 5e8e65c267
1 changed files with 21 additions and 0 deletions

View File

@ -1,5 +1,12 @@
# spiff-arena # spiff-arena
SpiffArena is a low(ish)-code software development platform for building, running, and monitoring executable diagrams. It is intended to support Citizen Developers and help increase their ability to contribute to the software development process. Using tools that look at lot like flow-charts and spreadsheets, it is possible to design some complex rules in a way that everyone in an organization can see and understand - and that are directly executable.
Please visit `SpiffWorkflow.org <https://www.spiffworkflow.org>`_ for a Getting Started Guide on how to run SpiffArena locally and try it out. There are also
additional articles, videos, and tutorials about SpiffArena and it's components - SpiffWorkflow, Service Connectors, and BPMN.js extensions.
# Contributing
This is a monorepo based on git subtrees that pulls together various This is a monorepo based on git subtrees that pulls together various
spiffworkflow-related projects. Here's an example command to push back to one spiffworkflow-related projects. Here's an example command to push back to one
project: project:
@ -15,3 +22,17 @@ Requires at root:
- .flake8 - .flake8
- .pre-commit-config.yaml - .pre-commit-config.yaml
- pyproject.toml - pyproject.toml
License
-------
SpiffArena's main components under 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>`_