Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
Riimu committed Jul 15, 2017
1 parent 6d3a159 commit 12916ca
Show file tree
Hide file tree
Showing 2 changed files with 44 additions and 27 deletions.
8 changes: 8 additions & 0 deletions CHANGES.md
@@ -1,5 +1,13 @@
# Changelog #

## v1.2.0 (2017-07-15) ##

* Increase minimum required PHP version to 5.6
* Improve the bundled autoloader
* Update tests to work with PHPUnit 6
* Update to latest coding standards
* Update the travis build to test for PHP7.1

## v1.1.1 (2015-08-22) ##

* Address minor documentation and coding standards issues
Expand Down
63 changes: 36 additions & 27 deletions README.md
Expand Up @@ -23,48 +23,57 @@ at: http://kit.riimu.net/api/baseconversion/

## Requirements ##

In order to use this library, the following requirements must be met:

* PHP version 5.6
* GMP extension must be enabled
* The minimum supported PHP version is 5.6
* The library depends on the following PHP Extensions
* [`gmp`](http://php.net/manual/en/book.gmp.php) (only required IDN support)

## Installation ##

This library can be installed by using [Composer](http://getcomposer.org/). In
order to do this, you must download the latest Composer version and run the
`require` command to add this library as a dependency to your project. The
easiest way to complete these two tasks is to run the following two commands
in your terminal:
### Installation with Composer ###

```
php -r "readfile('https://getcomposer.org/installer');" | php
php composer.phar require "riimu/kit-baseconversion:1.*"
```
The easiest way to install this library is to use Composer to handle your
dependencies. In order to install this library via Composer, simply follow
these two steps:

1. Acquire the `composer.phar` by running the Composer
[Command-line installation](https://getcomposer.org/download/)
in your project root.

2. Once you have run the installation script, you should have the `composer.phar`
file in you project root and you can run the following command:

```
php composer.phar require "riimu/kit-baseconversion:^1.2"
```

After installing this library via Composer, you can load the library by
including the `vendor/autoload.php` file that was generated by Composer during
the installation.

If you already have Composer installed on your system and you know how to use
it, you can also install this library by adding it as a dependency to your
`composer.json` file and running the `composer install` command. Here is an
example of what your `composer.json` file could look like:
### Adding the library as a dependency ###

If you are already familiar with how to use Composer, you may alternatively add
the library as a dependency by adding the following `composer.json` file to your
project and running the `composer install` command:

```json
{
"require": {
"riimu/kit-baseconversion": "1.*"
"riimu/kit-baseconversion": "^1.2"
}
}
```

After installing this library via Composer, you can load the library by
including the `vendor/autoload.php` file that was generated by Composer during
the installation.

### Manual installation ###

You can also install this library manually without using Composer. In order to
do this, you must download the [latest release](https://github.com/Riimu/Kit-BaseConversion/releases/latest)
and extract the `src` folder from the archive to your project folder. To load
the library, you can simply include the `src/autoload.php` file that was
provided in the archive.
If you do not wish to use Composer to load the library, you may also download
the library manually by downloading the [latest release](https://github.com/Riimu/Kit-BaseConversion/releases/latest)
and extracting the `src` folder to your project. You may then include the
provided `src/autoload.php` file to load the library classes.

Please note that using Composer will also automatically download the other
required PHP libraries. If you install this library manually, you will also need
to make those other required libraries available.

## Usage ##

Expand Down

0 comments on commit 12916ca

Please sign in to comment.