Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
jeroendesloovere committed May 18, 2018
1 parent ccb665d commit f4504c9
Showing 1 changed file with 10 additions and 7 deletions.
17 changes: 10 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,25 +1,28 @@
# Module: Banners
# Banners module for Fork CMS 5

The Banners module lets you add banner campaignes to your website. According to your preferences you can group them so a different banner get displayed on the same position. The dimensions of the banners can get customized on the settings page.
> The Banners module lets you add banner campaigns to your website.
Additionaly, some basic statistics are built-in, for example the amount of views and clicks are tracked.
## Features

* Widget: Bootstrap Carousel showing all the banners
* Uses Doctrine & Symfony Form
* Multi-language support

## Installation

Visit the [Fork CMS knowledge base](http://fork-cms.com/knowledge-base) to learn how to install a module. To download the zip-package go to the [extension page](http://www.fork-cms.com/extensions/detail/banners) of the module on fork-cms.com.

* [Download this module](https://github.com/friends-of-forkcms/fork-cms-module-banners/archive/master.zip)
* "Upload module" in your Fork CMS
* Install the module

## Contributing

It would be great if you could help us improve the module. GitHub does a great job in managing collaboration by providing different tools, the only thing you need is a [GitHub](https://github.com/) login.

* Use **Pull requests** to add or update code
* **Issues** for bug reporting or code discussions
* Or regarding documentation and how-to's, check out **Wiki**

More info on how to work with GitHub on [help.github.com](https://help.github.com).

## License

The module is licensed under MIT. In short, this license allows you to do everything as long as the copyright statement stays present.
The module is licensed under MIT. In short, this license allows you to do everything as long as the copyright statement stays present.

0 comments on commit f4504c9

Please sign in to comment.