README.md

Statifier

A Statecharts spec and implementation.

Report Bug / Request Feature

Table of Contents

• About the Project
• Getting Started
  • Installation
• Roadmap
• Contributing
• License
• Contact
• Alternatives
• Acknowledgements

About The Project

Statecharts are amazing and should be used in more places. Statifier provides a Statechart library for Elixir and Ruby.

NOTE: This is a work in progress. Many of the claims made here are currently part of the vision, but may not yet be true.

Getting Started

To get a local copy up and running follow these simple steps.

Installation

1. Clone and cd into the repo

git clone https://github.com/riddler/statifier.git
cd statifier

2. Install dependencies and setup the development environment

./bin/setup

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Adds some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

See the Contribution Guidelines for more information

License

Distributed under the MIT License. See LICENSE for more information.

Contact

JohnnyT - @johnny_t

Project Link: https://github.com/riddler/statifier

Alternatives

• XState is an AMAZING Statecharts implementation in TypeScript.
• statecharts.github.io is a great resource for learning about Statecharts.

Acknowledgements

• Best README Template
• Top Ten Reasons Why I Won't Use Your Open Source Project