search

indiana-university / conduit

A JavaScript library for architecting user interfaces with RxJS and React.
BSD 3-Clause "New" or "Revised" License
5 stars 0 forks source link

Update README to remove peer dependency versions #108

Closed james-anderson-iu closed 2 years ago

james-anderson-iu commented 2 years ago

With the release of conduit-rxjs@0.6.0 and conduit-rxjs-react@0.7.0 there was one detail we missed. The READMEs still say to install peer dependencies for React v0.14.0 and RxJS v6.2.0, but the package.json files say React v16.3.0 and RxJS v7.2.0. We should update the READMEs to reflect what is in the package.json files.

basham commented 2 years ago

I would be okay with removing the references to particular peer dependency versions in the READMEs. That way, the version numbers are only handled in package.json. NPM will complain to users if they install an incompatible peer dependency version. That should be good enough.

james-anderson-iu commented 2 years ago

That makes sense to me. I'm updating the description to reflect removing the peer dependency versions rather than updating them.