annotate vendor/jakub-onderka/php-console-highlighter/README.md @ 19:fa3358dc1485 tip

Add ndrum files
author Chris Cannam
date Wed, 28 Aug 2019 13:14:47 +0100
parents 129ea1e6d783
children
rev   line source
Chris@0 1 PHP Console Highlighter
Chris@0 2 =======================
Chris@0 3
Chris@0 4 Highlight PHP code in console (terminal).
Chris@0 5
Chris@0 6 Example
Chris@0 7 -------
Chris@0 8 ![Example](http://jakubonderka.github.io/php-console-highlight-example.png)
Chris@0 9
Chris@0 10 Install
Chris@0 11 -------
Chris@0 12
Chris@0 13 Just create a `composer.json` file and run the `php composer.phar install` command to install it:
Chris@0 14
Chris@0 15 ```json
Chris@0 16 {
Chris@0 17 "require": {
Chris@0 18 "jakub-onderka/php-console-highlighter": "0.*"
Chris@0 19 }
Chris@0 20 }
Chris@0 21 ```
Chris@0 22
Chris@0 23 Usage
Chris@0 24 -------
Chris@0 25 ```php
Chris@0 26 <?php
Chris@0 27 use JakubOnderka\PhpConsoleColor\ConsoleColor;
Chris@0 28 use JakubOnderka\PhpConsoleHighlighter\Highlighter;
Chris@0 29
Chris@0 30 require __DIR__ . '/vendor/autoload.php';
Chris@0 31
Chris@0 32 $highlighter = new Highlighter(new ConsoleColor());
Chris@0 33
Chris@0 34 $fileContent = file_get_contents(__FILE__);
Chris@0 35 echo $highlighter->getWholeFile($fileContent);
Chris@0 36 ```
Chris@0 37
Chris@0 38 ------
Chris@0 39
Chris@17 40 [![Downloads this Month](https://img.shields.io/packagist/dm/jakub-onderka/php-console-highlighter.svg)](https://packagist.org/packages/jakub-onderka/php-console-highlighter)
Chris@0 41 [![Build Status](https://travis-ci.org/JakubOnderka/PHP-Console-Highlighter.svg?branch=master)](https://travis-ci.org/JakubOnderka/PHP-Console-Highlighter)
Chris@17 42 [![License](https://poser.pugx.org/jakub-onderka/php-console-highlighter/license.svg)](https://packagist.org/packages/jakub-onderka/php-console-highlighter)