Skip to content

Commit

Permalink
Update the readme
Browse files Browse the repository at this point in the history
  • Loading branch information
duncan3dc committed Oct 23, 2017
1 parent 0825c5c commit c113ed3
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 19 deletions.
28 changes: 9 additions & 19 deletions README.md
Expand Up @@ -11,38 +11,28 @@ Running PHP from the command line? CLImate is your new best bud.

CLImate allows you to easily output colored text, special formats, and more.

## Table of Contents

+ [Installation](#installation)
+ [Requirements](#requirements)
+ [Documentation](#documentation)
+ [Credits](#credits)

## Installation

Using [composer](https://packagist.org/packages/league/climate):

```bash
$ composer require league/climate
```

## Requirements

The following versions of PHP are supported by this version.
## Quick Example
```php
require_once __DIR__ . "vendor/autoload.php";

+ PHP 5.4
+ PHP 5.5
+ PHP 5.6
+ PHP 7.0
+ PHP 7.1
+ PHP 7.2
$climate = new \League\CLImate\CLImate;

## Documentation
$climate->red('Whoa now this text is red.');
$climate->blue('Blue? Wow!');
```

CLImate has [full documentation](http://climate.thephpleague.com), powered by [Jekyll](http://jekyllrb.com/).
_Read more at http://climate.thephpleague.com/_

Contribute to this documentation in the [gh-pages branch](https://github.com/thephpleague/climate/tree/gh-pages/).

## Credits

This library was created by [Joe Tannenbaum](https://joe.codes/).
Much love to [Damian Makki](https://dribbble.com/damianmakki) for the logo.
5 changes: 5 additions & 0 deletions composer.json
Expand Up @@ -9,6 +9,11 @@
"email": "hey@joe.codes",
"homepage": "http://joe.codes/",
"role": "Developer"
}, {
"name": "Craig Duncan",
"email": "git@duncanc.co.uk",
"homepage": "https://github.com/duncan3dc",
"role": "Developer"
}
],
"require": {
Expand Down

0 comments on commit c113ed3

Please sign in to comment.