Skip to content

Commit

Permalink
Add a little bit of documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
Marius Elvert committed Jul 9, 2019
1 parent 5b2bd4e commit e29d6b0
Showing 1 changed file with 17 additions and 0 deletions.
17 changes: 17 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# Ushiro

*ushiro* is an experimental, but battle proven, small library supporting the "backend" of a typical UI application.
It helps to implement a unidirectional UI architecture similar to redux.
* Experimental means that the interface is not stable! Use with caution
* Battle-proven means that it (or the "predecessor" code) is actively used in a couple of production projects

# Design

*ushiro* uses a generic event_bus to implement the forward "action path", i.e. reacting to user or remote input.
For the backward "store to view" path, it uses a lightweight "diffing" approach that makes it easy to read and react to changes in the data model in the same way.
It is usually used together with a Qt based UI.

# Interesting links

* [lager](/~https://github.com/arximboldi/lager) is a great unidirectional UI library for C++
* [redux](https://redux.js.org/) is probably the most famous unidrection UI library, but for JavaScript

0 comments on commit e29d6b0

Please sign in to comment.