IMPROVEMENT: Update README to include styled-components version compatibility

[unicornware]

General Information

• [ ] Bug
• [x] Improvement
• [ ] Feature
• [ ] Other

Description

Although the project package.json properly indicates compatible versions of styled-components, this information should be included in the README so that it is easily accessible to developers.

After migrating from Jest to a Mocha x Chai setup, I was hoping to use this library to replace jest-styled-components.

But because I'm using [email protected], this isn't possible. Instead, I was met with the following error:

✖ ERROR: Error: Could not find styled-components v3 secret internals
    at getStyleSheet (/Users/lex/Projects/PLST/ps-analytics/packages/ui/node_modules/styled-components-test-utils/lib/utils/styleSheet.js:14:13)
    at Object.<anonymous> (/Users/lex/Projects/PLST/ps-analytics/packages/ui/node_modules/styled-components-test-utils/lib/utils/styleSheet.js:28:22)

Steps to reproduce

N/A

Versions

• styled-components-test-utils: 1.0.2

• node: 16.0.0

• chai: 4.3.4

• expect: n/a

• jasmine: n/a

• jest: n/a

Additional context

• I originally found this library via jest-styled-components#84
• Not sure if this library is still maintained, but in lieu of a documentation update, a library update or getting the nailed project from #2 started again would be great if possible (I don't have the bandwidth for contributions at the moment unfortunately)