Skip to content
This repository was archived by the owner on Jul 19, 2025. It is now read-only.

Commit 45077fe

Browse files
committed
Updated readme
1 parent eed8c37 commit 45077fe

File tree

1 file changed

+14
-14
lines changed

1 file changed

+14
-14
lines changed

README.md

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
1-
# Very short description of the package
1+
# Bee Plugin PHP Client
22

33
[![Latest Version on Packagist](https://img.shields.io/packagist/v/kirschbaum-development/bee-plugin-php-client.svg?style=flat-square)](https://packagist.org/packages/kirschbaum-development/bee-plugin-php-client)
44
[![Build Status](https://img.shields.io/travis/kirschbaum-development/bee-plugin-php-client/master.svg?style=flat-square)](https://travis-ci.org/kirschbaum-development/bee-plugin-php-client)
55
[![Quality Score](https://img.shields.io/scrutinizer/g/kirschbaum-development/bee-plugin-php-client.svg?style=flat-square)](https://scrutinizer-ci.com/g/kirschbaum-development/bee-plugin-php-client)
66
[![Total Downloads](https://img.shields.io/packagist/dt/kirschbaum-development/bee-plugin-php-client.svg?style=flat-square)](https://packagist.org/packages/kirschbaum-development/bee-plugin-php-client)
77

8-
This is where your description should go. Try and limit it to a paragraph or two, and maybe throw in a mention of what PSRs you support to avoid any confusion with users and contributors.
8+
PHP client to interact with Bee's plugin API. This includes the [Message Services API](https://docs.beefree.io/message-services-api-reference/) and a convinient way to use [authorization](https://docs.beefree.io/authorization-process/).
99

1010
## Installation
1111

@@ -17,8 +17,13 @@ composer require kirschbaum-development/bee-plugin-php-client
1717

1818
## Usage
1919

20+
First thing you will need is to instantiate the `Bee` base class and setup the API token. You can grab the API token by logging in into the [Developer portal](https://developers.beefree.io) and going to the "details" of your application.
21+
2022
``` php
21-
// Usage description here
23+
use KirschbaumDevelopment\Bee\Bee;
24+
25+
$bee = new Bee(new \GuzzleHttp\Client);
26+
$bee->setApiToken('your-api-token-here');
2227
```
2328

2429
### Testing
@@ -27,27 +32,22 @@ composer require kirschbaum-development/bee-plugin-php-client
2732
composer test
2833
```
2934

30-
### Changelog
31-
32-
Please see [CHANGELOG](CHANGELOG.md) for more information what has changed recently.
33-
3435
## Contributing
3536

3637
Please see [CONTRIBUTING](CONTRIBUTING.md) for details.
3738

3839
### Security
3940

40-
If you discover any security related issues, please email [email protected] instead of using the issue tracker.
41+
If you discover any security related issues, please email [email protected] or [email protected] instead of using the issue tracker.
4142

4243
## Credits
4344

44-
- [Luis Dalmolin](https://github.com/kirschbaum-development)
45-
- [All Contributors](../../contributors)
45+
- [Luis Dalmolin](https://github.com/luisdalmolin)
4646

47-
## License
47+
## Sponsorship
4848

49-
The MIT License (MIT). Please see [License File](LICENSE.md) for more information.
49+
Development of this package is sponsored by Kirschbaum Development Group, a developer driven company focused on problem solving, team building, and community. Learn more [about us](https://kirschbaumdevelopment.com) or [join us](https://careers.kirschbaumdevelopment.com)!
5050

51-
## PHP Package Boilerplate
51+
## License
5252

53-
This package was generated using the [PHP Package Boilerplate](https://laravelpackageboilerplate.com).
53+
The MIT License (MIT). Please see [License File](LICENSE.md) for more information.

0 commit comments

Comments
 (0)