Skip to content

Commit

Permalink
Added composer to README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
BrandonXLF committed Oct 21, 2020
1 parent 658c3d9 commit 6b05479
Show file tree
Hide file tree
Showing 2 changed files with 24 additions and 2 deletions.
2 changes: 1 addition & 1 deletion .gitattributes
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
# Auto detect text files and perform LF normalization
* text=auto
* text=auto
24 changes: 23 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,29 @@ An advantage of the approach of converting to PHP data types is that it is very

## Installation

To install this library, download the NBT.php file and load it using:
## Composer

This library can be downloaded using [Composer](https://getcomposer.org/). For example you can add the following to your `composer.json` file.

```json
{
"require": {
"brandon/nbt": "*"
}
}
```

It is recommended to replace `*` with a version constraint.

## Git

There are several ways to download directly from GitHub, the only required file is `NBT.php`.

- Download `NBT.php` via https://raw.githubusercontent.com/BrandonXLF/NBT.php/master/NBT.php
- Clone repository using `git clone https://github.com/BrandonXLF/NBT.php`
- Download code from GitHub

After downloading, to use the library you would use:
```php
require 'NBT.php';
```
Expand Down

0 comments on commit 6b05479

Please sign in to comment.