Skip to content

Commit 047c29b

Browse files
committed
Update docs for release
1 parent efaff07 commit 047c29b

File tree

1 file changed

+17
-9
lines changed

1 file changed

+17
-9
lines changed

Diff for: README.md

+17-9
Original file line numberDiff line numberDiff line change
@@ -50,6 +50,17 @@ php spark publish
5050
> *Note: jQuery is included because some other libraries depend on it; should those libraries
5151
> remove it as a dependency or be removed themselve then jQuery will no longer be included.
5252
53+
## Versioning
54+
55+
The intent is to maintain two major versions of this library for an indefinite amount of
56+
time until AdminLTE 4 is fully released and stable for production use. The core differences
57+
will be around the dependency stack for AdminLTE, Bootstrap, and jQuery.
58+
59+
| Library version | Bootstrap version | AdminLTE version | jQuery |
60+
| --------------: | -----------------: | ----------------: | :----: |
61+
| `1.x` | `4.x` | `3.x` | Yes |
62+
| `2.x` | `5.x` | `4.x` | No |
63+
5364
## Configuration
5465

5566
*For full configuration details see the [Assets docs](https://github.com/tattersoftware/codeigniter4-assets).*
@@ -108,13 +119,10 @@ includes jQuery), so while there is no harm in repeating assets it is also unnec
108119
This does not extend to optional plugins, e.g. if you want to use FontAwesome in AdminLTE
109120
you will need to include both.
110121

111-
## Versioning
112-
113-
The intent is to maintain two major versions of this library for an indefinite amount of
114-
time until AdminLTE 4 is fully released and stable for production use. The core differences
115-
will be around the dependency stack for AdminLTE, Bootstrap, and jQuery.
122+
## Testing
116123

117-
| Library version | Bootstrap version | AdminLTE version | jQuery |
118-
| --------------: | -----------------: | ----------------: | :----: |
119-
| `1.x` | `4.x` | `3.x` | Yes |
120-
| `2.x` | `5.x` | `4.x` | No |
124+
This library includes some PHPUnit extension classes in **src/Test/** to assist with testing
125+
vendor-sourced Bundles and Publishers. These are uses to test the files from this library
126+
but are also available for other projects that use `Tatter\Frontend`. To test your own
127+
classes simply extend the appropriate test case and add a data provider method with your
128+
class name and criteria to meet. See the test files in **tests/** for examples.

0 commit comments

Comments
 (0)