Add readme.

This commit is contained in:
David Molineus
2015-01-10 13:25:21 +01:00
parent cb3f697eb7
commit 178aabe304
3 changed files with 44 additions and 3 deletions

40
README.md Normal file
View File

@@ -0,0 +1,40 @@
Libraries for Leaflet integration into Contao CMS
=================================================
[![Version](http://img.shields.io/packagist/v/netzmacht/contao-leaflet-libraries.svg?style=flat-square)](http://packagist.com/packages/netzmacht/contao-leaflet-libraries)
[![License](http://img.shields.io/packagist/l/netzmacht/contao-leaflet-libraries.svg?style=flat-square)](http://packagist.com/packages/netzmacht/contao-leaflet-libraries)
[![Downloads](http://img.shields.io/packagist/dt/netzmacht/contao-leaflet-libraries.svg?style=flat-square)](http://packagist.com/packages/netzmacht/contao-leaflet-libraries)
This package is just a bundle of leaflet libraries required by
[netzmacht/contao-leaflet-maps](https://github.com/netzmacht/contao-leaflet-maps) - the Leaflet maps integration into
Contao CMS.
This package contains following packages:
- [leaflet 0.7.3](http://leafletjs.com)
- [Leaflet-providers 1.0.12](http://leaflet-extras.github.io/leaflet-providers)
- [leaflet-ajax 1.1.0](https://github.com/calvinmetcalf/leaflet-ajax)
- [Leaflet.loading 0.1.13](https://github.com/ebrelsford/Leaflet.loading)
- [Leaflet Control Geocoder 1.0.0](https://github.com/perliedman/leaflet-control-geocoder)
- [spin.js 2.0.2](http://fgnass.github.io/spin.js)
Install
-------
You can install this package via composer.
```
$ php composer.phar require netzmacht/contao-leaflet-libraries:~0.7
```
When releasing the first stable version of
[netzmacht/contao-leaflet-maps](https://github.com/netzmacht/contao-leaflet-maps) the version number gonna be the same
as the included leaflet library.
License
-------
As this package is just a meta package to provide the libraries, the licenses of each library have to be accepted. They
are unter the MIT or BSD license.

View File

@@ -1,6 +1,6 @@
{
"name":"netzmacht/contao-leaflet-libraries",
"description":"Javascript libraries for the Leaflet integration for Contao",
"description":"Javascript libraries for the Leaflet maps integration for Contao",
"keywords":["contao", "maps", "leaflet"],
"type":"contao-module",
"license":"LGPL-3.0+",
@@ -21,6 +21,9 @@
"php":">=5.4",
"contao/core":">=3.2,<3.5-dev"
},
"suggest": {
"netzmacht/contao-leaflet-maps": "Leaflet maps integration into Contao CMS"
},
"extra":{
"branch-alias": {
"dev-master": "0.7.3.x-dev"

View File

@@ -1,2 +0,0 @@
requires[] = "leaflet"