Skip to content

Commit 8d704b5

Browse files
author
Mikaël Capelle
committed
Update README.
1 parent 3fe5231 commit 8d704b5

File tree

1 file changed

+11
-24
lines changed

1 file changed

+11
-24
lines changed

README.md

Lines changed: 11 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ CakePHP 3.x Helpers for Bootstrap
55
[![Travis](https://img.shields.io/travis/Holt59/cakephp3-bootstrap-helpers/master.svg?style=flat-square)](https://travis-ci.org/Holt59/cakephp3-bootstrap-helpers)
66
[![Packagist](https://img.shields.io/packagist/dt/holt59/cakephp3-bootstrap-helpers.svg?style=flat-square)](https://packagist.org/packages/holt59/cakephp3-bootstrap-helpers)
77

8-
CakePHP 3.x Helpers to generate HTML with @Twitter Boostrap style: `Breadcrumbs`, `Flash`, `Form`, `Html`, `Modal`, `Navbar`,
8+
CakePHP 3.x Helpers to generate HTML with @Twitter Boostrap style: `Breadcrumbs`, `Flash`, `Form`, `Html`, `Modal`, `Navbar`,
99
`Panel` and `Paginator` helpers available!
1010

1111
How to... ?
@@ -44,50 +44,37 @@ The full plugin documentation is available at https://holt59.github.io/cakephp3-
4444

4545
| Version | Bootstrap version | CakePHP version | Information |
4646
|---------|-------------------|-----------------|-------------|
47-
| master | 3 | >= 3.4.0 | Current active branch. |
48-
| > 3.0.5, <= 3.1.1 | 3 | >= 3.2.3, < 3.4.0 | Bug will be fixed (latest version only). |
49-
| <= 3.0.5 | 3 | >= 3.0.0 | Not actively maintained (open issues if necessary). |
50-
| 4.0.0-alpha | 4 | N/A | Outdated, do not use. |
47+
| master / 3.1.2 | 3 | >= 3.4.0 | Current active branch. |
48+
| > 3.0.5, <= 3.1.1 | 3 | >= 3.2.3, < 3.4.0 | Not actively maintained (open issue(s) if necessary). |
49+
| <= 3.0.5 | 3 | >= 3.0.0 | Deprecated. |
50+
| 4.0.0-alpha | 4 | N/A | Deprecated. |
5151
| 4.0.1-alpha | 4 | >= 3.4.0 | Coming soon... |
5252

5353
#### Contributing
5454

5555
Do not hesitate to [**post a github issue**](https://github.com/Holt59/cakephp3-bootstrap-helpers/issues/new) or [**submit a pull request**](https://github.com/Holt59/cakephp3-bootstrap-helpers/pulls) if you find a bug or want a new feature.
5656

5757

58-
Version 3.1 of the helpers is out!
58+
Current version: 3.1.2
5959
==================================
6060

61-
A new major version **3.1** of the helpers is now out. This version brings major changes to the way helpers internally works by using
62-
templates instead of the standard `tag()` and `div()` method.
61+
The current version of the helpers is `3.1.2`, this means that new features will not be ported to older versions (i.e. `<= 3.1.1`).
62+
If you are migrating from a version `< 3.1.0`, feel free to open issues if you encounter problems since version `3.1.0` brought a lot
63+
of changes.
6364

6465
#### Changes
6566

6667
- Most methods are now based on templates, meaning that:
6768
- Options like `tag`, `aria-*`, `data-*`, ..., have been dropped from various methods.
6869
- The `templateVars` options is now usable with most methods.
6970
- There might be escaping issue since the old `div()` and `tag()` methods did not escape content be default, while
70-
the template based methods do. Feel free to open an [issue](https://github.com/Holt59/cakephp3-bootstrap-helpers/issues/new) if
71+
the template based methods do. Feel free to open an [issue](https://github.com/Holt59/cakephp3-bootstrap-helpers/issues/new) if
7172
you encounter problems with escaping.
7273

7374
Some minor changes that do not impact the user interface:
74-
- The `BootstrapTrait` class has been split in two classes: `ClassTrait` and `EasyIconTrait`.
75+
- The `BootstrapTrait` class has been split in two classes: `ClassTrait` and `EasyIconTrait`.
7576
- The test cases have been updated and strenghten to avoid bad modification in the code.
7677

77-
#### Migrating to 3.1
78-
79-
List of changes that need refactoring in your code:
80-
81-
- `BootstrapHtmlHelper`
82-
- The `faIcon` and `glIcon` have been dropped.
83-
- The `useFontAwesome` options has been dropped, the new way is to customize the `icon` template.
84-
- It is no longer possible to use custom `tag` to render labels, badges, alerts (still possible for `tooltip`).
85-
- `BootstrapNavbarHelper`
86-
- The `autoButtonLink` options has been dropped, this was misleading for many users.
87-
88-
Some options such as `aria-*`, `data-*`, have been dropped from various methods since these are now included in the templates,
89-
if you want to customize them, you should modify the template.
90-
9178
Who is using it?
9279
================
9380

0 commit comments

Comments
 (0)