Move directories around

FILES.md

@@ -206,7 +206,7 @@ It facilitates the role of loading the Manifest and new segments for the rest of
 the core.
 
 
-### `src/core/segment_buffers/`: Media buffers
+### `src/core/segment_sinks/`: Media buffers
 
 Code allowing to interact with the media buffers called `SegmentBuffers`.
 

src/compat/README.md

@@ -2,7 +2,7 @@
 
 | Consideration           | Status                                      |
 |-------------------------|---------------------------------------------|
-| Preferred import style  | Compat files should be imported directly    |
+| Preferred import style  | Compat files can be imported directly       |
 | Multithread environment | Main thread or WebWorker depending on file  |
 
 ## Overview ####################################################################

src/core/README.md

@@ -1,32 +1,27 @@
 # RxPlayer core ################################################################
 
-| Consideration           | Status                                              |
-|-------------------------|-----------------------------------------------------|
-| Preferred import style  | The `core` directory shouldn't be imported directly |
-| Multithread environment | Depends, see inner directories' `README.md` files   |
+| Consideration           | Status                                     |
+|-------------------------|--------------------------------------------|
+| Preferred import style  | Depends on the environment [1]             |
+| Multithread environment | Should be runnable in a WebWorker entirely |
+
+[1] In a Multithreading mode, only the `types` file should probably be imported
+by external code (to ensure a small bundle size). In a monothreading mode,
+files from the `core_portal` subdirectory may be directly imported.
 
 ## Overview ####################################################################
 
 The "core" regroups multiple modules constituting the central logic of the
-RxPlayer.
+RxPlayer which can optionally run in a WebWorker environment.
 
 Those modules are:
 
-  - __the `API` (./api)__
-
-    Defines the public API of the RxPlayer and provides abstractions to help
-    implementing it.
-
-
-  - __the `ContentInitializer` (_./init)__
-
-    Initialize playback and connects different modules between one another.
-
+  - __the `CorePortal` (_./core_portal)__
 
-  - __the `ContentDecryptor` (./decrypt)__
+    Make the link between the "main thread" part of the code and the core.
 
-    Negotiate content decryption.
-    Only used for contents with DRM (Digital Right Management).
+    When the core runs in a WebWorker, this is the part receiving and handling
+    messages from the main thread.
 
 
   - __the `AdaptiveRepresentationSelector` (./adaptive)__
@@ -41,19 +36,18 @@ Those modules are:
     called the `SegmentBuffers`) to then be able to decode them.
 
 
-  - __the `SegmentBuffers` (./segment_buffers)__
+  - __the `SegmentBuffers` (./segment_sinks)__
 
-    Implement media buffers on which loaded segments will be pushed.
+    Implement media sinks on which loaded segments will be pushed.
     The corresponding media data contained in them will then be decoded at the
     right time.
 
-    Those buffers can depend on browser implementations (for example for audio
+    Those can depend on browser buffers implementations (for example for audio
     and video contents, we rely on `SourceBuffer` JS objects) or may be
     completely defined in the code (for example, text track buffers in the
     `"html"` `textTrackMode` are entirely defined in the RxPlayer).
 
-    Those `SegmentBuffers` have added niceties over just being simple data
-    buffers. For example, they include an inventory which allows to retrieve the
+    Those `SegmentBuffers` include an inventory which allows to retrieve the
     metadata about every segments that is still contained within it.
 
   - __the `fetchers` (./fetchers)__