Add todo for optional query parameter implementation

digitonic · Oct 8, 2019 · 687c115 · 687c115
1 parent 41f6052
commit 687c115
Show file tree

Hide file tree

Showing 2 changed files with 50 additions and 0 deletions.
diff --git a/docs/README.md b/docs/README.md
@@ -0,0 +1,48 @@
+# IEX Cloud SDK
+
+[![Latest Version on Packagist](https://img.shields.io/packagist/v/digitonic/iex-cloud-sdk.svg?style=flat-square)](https://packagist.org/packages/digitonic/iex-cloud-sdk)
+[![Build Status](https://travis-ci.com/digitonic/iex-cloud-sdk.svg?branch=master)](https://travis-ci.com/digitonic/iex-cloud-sdk)
+[![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/digitonic/iex-cloud-sdk/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/digitonic/iex-cloud-sdk/?branch=master)
+[![Code Coverage](https://scrutinizer-ci.com/g/digitonic/iex-cloud-sdk/badges/coverage.png?b=master)](https://scrutinizer-ci.com/g/digitonic/iex-cloud-sdk/?branch=master)
+[![Total Downloads](https://img.shields.io/packagist/dt/digitonic/iex-cloud-sdk.svg?style=flat-square)](https://packagist.org/packages/digitonic/iex-cloud-sdk)
+
+A PHP package for accessing the IEX Cloud API. It focuses heavily on the Laravel Framework however it will work in any standalone project with usage of Composer.
+
+## Installation
+
+You can install the package via composer:
+
+```bash
+composer require digitonic/iex-cloud-sdk
+```
+
+## Usage
+
+Please see the [documentation](https://digitonic.github.io/iex-cloud-sdk/#/) for details.
+
+### Testing
+
+``` bash
+composer test
+```
+
+### Changelog
+
+Please see [CHANGELOG](CHANGELOG.md) for more information what has changed recently.
+
+## Contributing
+
+Please see [CONTRIBUTING](CONTRIBUTING.md) for details.
+
+### Security
+
+If you discover any security related issues, please email [email protected] instead of using the issue tracker.
+
+## Credits
+
+- [Steven Richardson](https://github.com/richdynamix)
+- [All Contributors](../../contributors)
+
+## License
+
+The MIT License (MIT). Please see [License File](LICENSE.md) for more information.
diff --git a/docs/dev-status.md b/docs/dev-status.md
@@ -4,6 +4,8 @@
 
 Below is a list of endpoints to be implemented. (46/97)
 
+!> **TODO** Optional query parameters
+
 ### Account
 
 - [x] Metadata