docs: compatability matrix?

Laurens-makel commented 9 months ago

I'm submitting a...


[ ] Regression (a behavior that used to work and stopped working in a new release)
[ ] Bug report  
[ ] Performance issue
[ ] Feature request
[X ] Documentation issue or request
[ ] Support request
[ ] Other... Please describe:

Current behavior

I've been looking for a compatability matrix which would map the library's version against the supported Angular versions.

Expected behavior

Something like the following, this example is taken from RxAngular library.

Minimal reproduction of the problem with instructions

None

What is the motivation / use case for changing the behavior?

Help new users of the library to pick the correct version for their application.

Environment


Angular version: X.Y.Z


Browser:
- [ ] Chrome (desktop) version XX
- [ ] Chrome (Android) version XX
- [ ] Chrome (iOS) version XX
- [ ] Firefox version XX
- [ ] Safari (desktop) version XX
- [ ] Safari (iOS) version XX
- [ ] IE version XX
- [ ] Edge version XX

For Tooling issues:
- Node version: XX  
- Platform:  

Others:

shaharkazaz commented 9 months ago

@Laurens-makel You are welcome to open a PR and add it to the README. You can find the support in the changelog

Laurens-makel commented 9 months ago

@Laurens-makel You are welcome to open a PR and add it to the README. You can find the support in the changelog

Allright, there you go.

Why are the releases for Angular v15 & v16 skipped....?

shaharkazaz commented 9 months ago

@Laurens-makel it wasn't, v3.1.0 requires Angular >13

ngneat / cashew