Update README ?

Open blake-regalia opened this issue 6 years ago • 1 comments

I think it would be nice to have an organized overview of all the features on the README. Ideally, this would give the public an idea of what distinguishes this package from others, which is quite a lot. And then perhaps move all the release history stuff to CHANGELOG.md?

If this sounds okay, I can get a PR started in the next few days/weeks.

Dec 25 '19 20:12 blake-regalia

Sounds great to me. A lot of the notes from early on are likely either outdated or not especially important, so don’t feel obligated to retain stuff that you don’t think is helpful. Maybe if some of the more implementation details-y stuff and the scopes list were placed in distinct markdown files it’d help get it more focused?

Dec 25 '19 21:12 bathos