From ecb95d402c2d1f2b4256332fed36fda7199e6c32 Mon Sep 17 00:00:00 2001 From: Wogan May Date: Fri, 4 May 2018 01:16:48 +0200 Subject: [PATCH] Updating documentation --- README.md | 18 +++++++++++------- docs/services.rst | 2 +- 2 files changed, 12 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 1f3ad84..6d9094a 100644 --- a/README.md +++ b/README.md @@ -14,16 +14,20 @@ If you get stuck, ask for help in the support chat at: https://spectrum.chat/dom #### Contributing -Issues and pull requests accepted, while I work on finishing the next major update (0.2.0), which will target all the current Domo APIs, including documentation. +Thanks for considering a contribution! + +The purpose of this library is to wrap all the Domo endpoints as per the developer documentation, and account for any edge cases. The Helpers are for general-purpose streamlining of common operations (not specific logic for any single industry, framework or application). + +Finally, this library is still under active development until it reaches a parity release with the Domo API. If you're having issues, please ask questions in the Spectrum chat (linked above), or lodge a GitHub issue. Pull requests will only be accepted if they're written in a consistent style with the existing code, and maintain parity with the [documented APIs](https://developer.domo.com/docs/api-status/api-status) provided by Domo. | Capability | Service | Documentation | | --- | :---: | :---: | -| DataSets | Complete | [Complete](http://domo-php.readthedocs.io/en/latest/services.html#datasets) | -| Groups | Complete | [Complete](http://domo-php.readthedocs.io/en/latest/services.html#groups) | -| Pages | Complete | [Complete](http://domo-php.readthedocs.io/en/latest/services.html#pages) | -| Users | Complete | [Complete](http://domo-php.readthedocs.io/en/latest/services.html#users) | -| Streams | Working | Working | -| Activity Log | Working | Working | +| DataSets | Complete | [Complete](http://domo-php.readthedocs.io/en/latest/services.html#datasets) (0.1.0) | +| Groups | Complete | [Complete](http://domo-php.readthedocs.io/en/latest/services.html#groups) (0.2.0) | +| Pages | Complete | [Complete](http://domo-php.readthedocs.io/en/latest/services.html#pages) (0.2.0) | +| Users | Complete | [Complete](http://domo-php.readthedocs.io/en/latest/services.html#users) (0.2.0) | +| Activity Log | Working | [Complete](http://domo-php.readthedocs.io/en/latest/services.html#activity-logs) (0.2.0) | +| Streams | Working | Working (0.2.1) | #### Licensing diff --git a/docs/services.rst b/docs/services.rst index 3ed4ccb..379e893 100644 --- a/docs/services.rst +++ b/docs/services.rst @@ -9,7 +9,7 @@ The endpoint returns all the activity logs, sorted by event time descending. The $entries = $client->API->Admin->getActivityLog(); -To apply some filters, pass in an array of filters:: +To filter the results, you've got the following options:: $filters = [ "user" => 12345,