Skip to content

Commit 0057bcc

Browse files
committed
[TASK] Update README.md
1 parent c8f72c9 commit 0057bcc

File tree

1 file changed

+30
-9
lines changed

1 file changed

+30
-9
lines changed

README.md

Lines changed: 30 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,20 @@
11
# PHP KML parser
22

3+
[![Donate](https://img.shields.io/badge/Donate-PayPal-green.svg)](https://www.paypal.me/simonschaufi/10)
4+
[![Latest Stable Version](https://poser.pugx.org/simonschaufi/php-libkml/v/stable)](https://packagist.org/packages/simonschaufi/php-libkml)
5+
[![Total Downloads](https://poser.pugx.org/simonschaufi/php-libkml/downloads)](https://packagist.org/packages/simonschaufi/php-libkml)
6+
[![License](https://poser.pugx.org/simonschaufi/php-libkml/license)](https://packagist.org/packages/simonschaufi/php-libkml)
7+
38
A php library to parse KML/KMZ files.
49

5-
php-libKML maps KML/KMZ xml data into PHP objects that follow the KML specification.
6-
The purpose of the library is to create KML file from code, parse KML files and convert to another format maintaining the complete KML information.
10+
php-libKML maps KML/KMZ data into PHP objects that follow the KML specification.
11+
The purpose of the library is to create KML file from code, parse KML files and
12+
convert to another format maintaining the complete KML information.
713

814
## Features
915

1016
* KML schema version 2.2
11-
* PHP 7.1+
17+
* PHP 7.4+
1218
* Composer integration
1319
* Object oriented design
1420
* Comprehensive KML model
@@ -26,26 +32,41 @@ Future features:
2632
* GeoJson
2733
* WKT
2834

29-
## Installation
35+
## Usage
36+
37+
### Installation
3038

31-
It can be installed using composer.
39+
The recommended way to install the extension is using [Composer][1].
40+
41+
Run the following command within your Composer based TYPO3 project:
3242

3343
```bash
3444
composer require simonschaufi/php-libkml
3545
```
3646

37-
## Usage
47+
### Contribution
3848

39-
## Contribute
49+
**Pull Requests** are gladly welcome!
4050

41-
Execute unit tests
51+
Please remember to add an issue and connect it to your pull requests.
52+
It is very helpful to understand what kind of issue the PR is going to solve.
53+
54+
Bugfixes:
55+
56+
Please describe what kind of bug your fix solves
57+
and give us feedback on how to reproduce the issue.
58+
We're going to accept only bugfixes if we can reproduce the issue.
59+
60+
Execute unit tests:
4261

4362
```bash
4463
composer local:tests:unit
4564
```
4665

47-
Execute acceptance tests
66+
Execute acceptance tests:
4867

4968
```bash
5069
composer local:tests:acceptance
5170
```
71+
72+
[1]: https://getcomposer.org/

0 commit comments

Comments
 (0)