How to install and use the IDML-Creator

General

The IDML-Creator is written in PHP and can be used with Composer. It's a private library that needs to be licensed.

IDML-Creator makes use of semantic versioning, so new features, bugfixes and any other updates can be made safely and without breaking functionalities.

Dependencies

The IDML-Creator has some dependencies to third-party libraries:

Library	Version Constraint
ext-dom	*
ext-libxml	*
ext-xsl	*
bitandblack/colors	^2.4
bitandblack/composer-helper	^1.0 || ^2.0
bitandblack/helpers	^1.4 || ^2.0
bitandblack/iccprofile	^1.0
bitandblack/idml-writer	^2.0
bitandblack/image-information	^3.0
bitandblack/qr-code	^1.0
doctrine/annotations	^2.0
psr/cache	^1.0 || ^2.0 || ^3.0
symfony/string	^6.0 || ^7.0

Versions

The IDML-Creator aims to always support the latest 3 versions of PHP:

IDML-Creator	PHP Version Constraint
^5.0	~8.2 || ~8.3 || ~8.4
^4.0	~8.1 || ~8.2 || ~8.3
^3.0	~8.0 || ~8.1 || ~8.2

Adding to your project

After receiving your private name and token, follow these steps to add IDML-Creator to your project:

1. Add the repository config to your composer.json:

   $ composer config repositories.private-packagist composer https://bitandblack.repo.packagist.com/<YOUR_CUSTOMER_NAME>/

2. Add config information to your auth.json file once:

   $ composer config --auth http-basic.bitandblack.repo.packagist.com token <YOUR_CUSTOMER_TOKEN>

   Make sure to never commit the auth.json file into your repository, as it contains sensitive information.
3. Add the library:

   $ composer require bitandblack/idml-creator

4. Regenerate the composer.lock file:

   $ composer update