README

Handles api requests to smashcast nicely!

This library is actively supported and I'll update it constantly. If you want to contribute, don't hesitate to do anything. If you have any problems, just ask me. I'll work on it, but it may take some time. At the moment, I'm facing to creating tests.

I spend around half an hour per day with this library, so be patient. Please keep in mind I'm an pupil and have to learn for class tests :)

Installation

If something is missing, or something is not well explained or when you have a question, feel free to open an issue.

Make sure you meet the requirements of this lib:
- PHP 7.1+
- Composer
- allow_url_fopen must be enabled
- You comply with the MIT License
- You installed some root certificates, since all connections this library creates are secured via ssl.

Install using composer:

Execute composer require jens1o/smashcast-api-php-unofficial
In your script, add:

<?php
require_once './vendor/autoload.php';

// other code...

Use the lib.

Download without composer

Download/Clone this repository
Execute composer install in your clone
In your script, add:

<?php
require_once './vendor/autoload.php';

// other code...

Use the lib.

I recommend head over to the examples folder, or just dig through the code.

If you have any questions, do not hesitate to file an issue or ask me via twitter. I plan to do a documentation, but first I want to make sure I don't have any breaking changes.

Roadmap

Write some templates making contributions easier
Explore in chat possibilities => search for a good lib to accomplish this
Finalize structure
Make a documentation that everybody understands(I think I need some help when it comes to grammar...) :)

Working on your first Pull Request? You can learn how from this free series How to Contribute to an Open Source Project on GitHub

jens1o / smashcast-api-php-unofficial

Maintainers

Details