You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+12-3Lines changed: 12 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -61,11 +61,13 @@ Benefits
61
61
Quick start
62
62
-----------
63
63
64
-
To get started quickly, try our [quick start guide][Quickstart]. For a more thorough introduction continue reading.
64
+
To get started quickly consuming an existing Porter provider, try our [quick start guide][Quickstart]. For a more thorough introduction continue reading.
65
65
66
66
About this manual
67
67
-----------------
68
68
69
+
Those wishing to consume a Porter provider create one instance of `Porter` for their application and an instance of `ImportSpecification` for each data import they wish to perform. Those publishing providers must implement `Provider` and `ProviderResource`.
70
+
69
71
The first half of this manual covers Porter's main API for consuming data services. The second half covers architecture, interface and implementation details for publishing data services. There's an intermission in-between so you'll know where the separation is!
70
72
71
73
Text marked as `inline code` denotes literal code, as it would appear in a PHP file. For example, `Porter` refers specifically to the class of the same name within this library, whereas *Porter* refers to this project as a whole.
@@ -464,17 +466,24 @@ Requirements
464
466
Limitations
465
467
-----------
466
468
469
+
Current limitations that may affect some users and should be addressed in the near future.
470
+
467
471
- No end-to-end data steaming interface yet.
472
+
- Caching does not support asynchronous imports yet.
473
+
-[Sub-imports][] do not support async yet.
468
474
469
475
Testing
470
476
-------
471
477
472
-
Porter is fully unit tested. Run the tests with the `composer test` command. Run mutation tests with the `composer mutation` command.
478
+
Porter is fully unit and mutation tested.
479
+
480
+
* Run unit tests with the `composer test` command.
481
+
* Run mutation tests with the `composer mutation` command.
473
482
474
483
Contributing
475
484
------------
476
485
477
-
Everyone is welcome to contribute anything, from [ideas and issues][Issues] to [documentation and code][PRs]! For inspiration, consider the list of open [issues][].
486
+
Everyone is welcome to contribute anything, from [ideas and issues][Issues] to [code and documentation][PRs]!
0 commit comments