jocic/qr-codes

Library for generating QR codes both locally and remotely.

dev-master 2019-01-27 15:56 UTC

This package is auto-updated.

Last update: 2024-04-28 03:56:54 UTC


README

Build Status Coverage Status Codacy Badge Latest Stable Version License

QR Codes is a PHP library providing a simple API for generating QR codes both locally and remotely.

Buy Me Coffee

Project is still under development...slow ride...take it easy...

Versioning Scheme

I use a 3-digit Semantic Versioning identifier, for example 1.0.2. These digits have the following meaning:

  • The first digit (1) specifies the MAJOR version number.
  • The second digit (0) specifies the MINOR version number.
  • The third digit (2) specifies the PATCH version number.

Complete documentation can be found by following the link above.

Requirements

You only need to have PHP >=7.0 available on your system to use QR Codes in your application. However, for running unit tests, you need to have the following extensions installed:

Installation

There's two ways you can add QR Codes library to your project:

  • Copying files from the "source" directory to your project and requiring the "Autoload.php" script
  • Via Composer, by executing the command below
composer require jocic/qr-codes dev-master

Tests

Following unit tests are available:

  • Essentials - Tests for library's essential elements.

You can execute them easily from the terminal like in the example below.

bash ./scripts/phpunit.sh --testsuite essentials

Please don’t forget to install necessary dependencies before attempting to do the God's work above. They may be important.

bash ./scripts/composer.sh install

Contribution

Please review the following documents if you are planning to contribute to the project:

Integration

My hourly rate is fairly reasonable so, if you need help with integrating QR Codes to your existing project, feel free to contact me via the email below.

Integration inquiries: office@djordjejocic.com

Support

Please don't hesitate to contact me if you have any questions, ideas, or concerns.

My Twitter account is: @jocic_91

My support E-Mail address is: support@djordjejocic.com

Copyright & License

Copyright (C) 2018 Đorđe Jocić

Licensed under the MIT license.