Skip to content

Commit

Permalink
updated: documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
GianlucaGuarini committed Aug 18, 2015
1 parent 4c9469b commit ee38dfe
Show file tree
Hide file tree
Showing 3 changed files with 15 additions and 12 deletions.
16 changes: 15 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,21 @@
[![MIT License][license-image]][license-url]
[![Coverage Status][coverage-image]][coverage-url]

[Description](doc/index.md) - [API](doc/api.md)
# Observable

Observable is a generic tool to send and receive events. It's a common pattern to isolate modules without forming a dependency or "coupling". By using events a large program can be broken into smaller and simpler units. Modules can be added, removed, or modified without affecting the other parts of the application.

A common practice is to split the application into a single core and multiple extensions. The core sends events any time something remarkable happens: a new item is being added, an existing item is being removed, or something is loaded from the server.

By using the observable the extensions can listen to these events and react to them. They extend the core so that the core is not aware of these modules. This is called "loose coupling".

These extensions can be custom tags (UI components) or non-UI modules.

Once the core and events are carefully designed the team members are enabled to develop the system on their own without disturbing others.

## Documentation

- [API (English)](doc/)

## Installation

Expand Down
File renamed without changes.
11 changes: 0 additions & 11 deletions doc/index.md

This file was deleted.

0 comments on commit ee38dfe

Please sign in to comment.