ReviewOS

also looking at this

meemalabs/meema-client-php

initialize progress

#1
Merged glennmichael123 wants to merge initial-progress into main
17 files +581 -48

Review threads live on the whole diff, not on one commit, so none are shown here - a thread's line means something in the branch's final form, and painting it into an intermediate step would put it on code it is not about.

LICENSE.mdadded+21-0
Changes to LICENSE.md
@@ -0,0 +1,21 @@
1MIT License
2
3Copyright (c) Meema, Inc.
4
5Permission is hereby granted, free of charge, to any person obtaining a copy
6of this software and associated documentation files (the "Software"), to deal
7in the Software without restriction, including without limitation the rights
8to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9copies of the Software, and to permit persons to whom the Software is
10furnished to do so, subject to the following conditions:
11
12The above copyright notice and this permission notice shall be included in all
13copies or substantial portions of the Software.
14
15THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21SOFTWARE.
README.mdmodified+52-33
Changes to README.md
@@ -1,49 +1,68 @@
1# Coming Soon - Meema.io API
1<p align="center">
2 <a href="https://meema.io">
3 <img alt="Meema for PHP" src="https://raw.githubusercontent.com/meema/meemasearch-client-common/master/banners/php.png" >
4 </a>
25
3This package contains a [Flysystem](https://flysystem.thephpleague.com/) adapter for Meema. Under the hood, the Meema API is used.
6<h4 align="center">The most simple way to integrate <a href="https://meema.io" target="_blank">Meema</a> and your PHP project</h4>
47
5## Installation
8<p align="center">
9 <a href="https://scrutinizer-ci.com/g/meemalabs/meema-client-php/badges/quality-score.png?b=main"><img src="https://scrutinizer-ci.com/g/meemalabs/meema-client-php/badges/quality-score.png?b=main" alt="Scrutinizer" /></a>
10 <a href="https://packagist.org/packages/meema/meema-client-php"><img src="https://poser.pugx.org/meema/meema-client-php/d/total.svg" alt="Total Downloads"></a>
11 <a href="https://packagist.org/packages/meema/meema-client-php"><img src="https://poser.pugx.org/meema/meema-client-php/v/stable.svg" alt="Latest Version"></a>
12 <a href="https://packagist.org/packages/meema/meema-client-php"><img src="https://poser.pugx.org/meema/meema-client-php/license.svg" alt="License"></a>
13</p>
614
7You can install the package via composer:
15<p align="center">
16 <a href="https://www.meema.com/doc/api-client/getting-started/install/php/" target="_blank">Documentation</a> •
17 <a href="https://github.com/meema/laravel-meema" target="_blank">Laravel</a> •
18 <a href="http://stackoverflow.com/questions/tagged/meema" target="_blank">Stack Overflow</a> •
19 <a href="https://github.com/meema/meema-client-php/issues" target="_blank">Report a bug</a> •
20 <a href="https://meema.io/docs" target="_blank">FAQ</a> •
21 <a href="https://meema.io/support" target="_blank">Support</a>
22</p>
823
9``` bash
10composer require meemaio/meema-api
11```
12
13## Usage
24## ✨ Features
1425
15The first thing you need to do is get an authorization token at Meema.io. A token can be generated in the [App Console](https://meema.io/) for any Meema API app.
26- Thin & minimal low-level HTTP client to interact with Meema's API
27- Supports php `^5.*`.
1628
17``` php
18use League\Flysystem\Filesystem;
19use Meema\Client;
20use Meema\FlysystemMeema\MeemaAdapter;
29## 💡 Usage
2130
22$client = new Client($authorizationToken);
31First, install Meema PHP API Client via the [composer](https://getcomposer.org/) package manager:
2332
24$adapter = new MeemaAdapter($client);
25
26$filesystem = new Filesystem($adapter);
33```bash
34composer require meema/meema-client-php
2735```
2836
29## Changelog
30
31Please see [CHANGELOG](CHANGELOG.md) for more information what has changed recently.
32
33## Testing
34
35``` bash
36composer test
37Then, wip
38
39```php
40$client->folders()->get();
41$client->folders(1, 2, 3)->delete();
42$client->folders(1)->update(['name' = 'New Folder Name']);
43$client->folders([1, 2, 3])->media()->get();
44$client->tags()->get();
45$client->tags(1, 2, 3)->delete();
46$client->tags(1)->update(['name' = 'New Tag Name']);
47$client->tags([1, 2, 3])->media()->get();
48// need to the same for following resources
49$client->favorites()->get();
50$client->media()->get();
51$client->teams()->get();
52
53$client->media()->get();
54$client->media()->search($q);
55
56$client->folders()->get();
57$client->folders()->search($q);
3758```
3859
39## Contributing
40
41Please see [CONTRIBUTING](CONTRIBUTING.md) for details.
60For the full documentation, visit the **[Meema PHP API Client](https://meema.io/docs/)**.
4261
43## Security
62## ❓ Troubleshooting
4463
45If you discover any security related issues, please email chris@cion.agency instead of using the issue tracker.
64Encountering an issue? Before reaching out to support, we recommend heading to our [FAQ](https://meema.io/docs/) where you will find answers for the most common issues and gotchas with the client.
4665
47## License
66## 📄 License
4867
49The MIT License (MIT). Please see [License File](LICENSE.md) for more information.
68Meema PHP API Client is an open-sourced software licensed under the [MIT license](LICENSE.md).