Skip to content

Commit 39d8e32

Browse files
committed
Updated readme.
1 parent 4efee0c commit 39d8e32

File tree

1 file changed

+12
-3
lines changed

1 file changed

+12
-3
lines changed

README.md

Lines changed: 12 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -61,11 +61,13 @@ Benefits
6161
Quick start
6262
-----------
6363

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.
6565

6666
About this manual
6767
-----------------
6868

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+
6971
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!
7072

7173
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
464466
Limitations
465467
-----------
466468

469+
Current limitations that may affect some users and should be addressed in the near future.
470+
467471
- No end-to-end data steaming interface yet.
472+
- Caching does not support asynchronous imports yet.
473+
- [Sub-imports][] do not support async yet.
468474

469475
Testing
470476
-------
471477

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.
473482

474483
Contributing
475484
------------
476485

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]!
478487

479488
License
480489
-------

0 commit comments

Comments
 (0)