Introduction

The reading system core functionalities

The core package is all you need to display content into a web page. This contains all the foundations and bases you need.

At some point you will realize that you need to add things like gestures, search, annotations etc. They are not part of the core because they can be opinionated and different between reading systems. However they can be built easily upon the core. That is by design but we also provide ready to use enhancers to implement the common features.

Design principles

We always try to add new features to the core as enhancers within the core package. They are transparent to the consumers but it ensures that the core is flexible enough for anyone to add features when needed and without having to contribute to the core.

You can see how we do it here.

When a feature is common or basic enough it may go into the core package. Otherwise we might make an enhancer package for it.

If it answers all the questions by YES, it should be in the core:

• Is it standard practice ?

• Is it likely needed by all developers ?

• Is it following strictly browser API ?