Documentation: add some notes about versioning and rework the README a bit #240
Conversation
docs: increase screenshot image size docs: de-centre readme title docs: move version badge to top of readme docs: move version badge to VERY top of readme docs: update screenshot chore: very minor updates to the readme typo another typo rewording indentation
|
Once this PR is merged I think all we'll need to do is create a 0.1.0 release on GitHub, then it should be possible to merge #237 and bump the version to 0.2.0. |
I agree, and the PR looks good to me. I'm unsure if we should put the version number near the top of |
I think shields.io should automatically detect the latest release, so I don't think we'll need to manually change it whenever there's a new release. Currently on my fork it says 'no releases or repo not found'. I agree though, if for any reason it doesn't automatically update we should change it. |
Co-authored-by: Philippe Massicotte <[email protected]>
|
All good on my side! |
|
Thanks! 🚀 |
As discussed in #237, this PR aims to make it clear to the users when and why breaking changes might occur, and what they can do about it. I've also taken the opportunity to reorganise the README a bit; I've aimed to make it a bit easier to skim-read, and I also added a screenshot at the top.