Replies: 1 comment 1 reply
-
I think the following would be my picks, but I'd like some feedback on this:
|
Beta Was this translation helpful? Give feedback.
1 reply
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
-
The primary goal of the README is to quickly describe IDOM is as quickly as possible. It should do this in no more that two sentences. If the reader is still interested, the content which follows should then make it easy for the reader to dive into the points of interest that caught their interest just prior.
The current README is much better than our old one, but I think there's still room for improvement. In the original README overhaul, @Archmonger laid down a set of points that we should try and get across. To some degree we touch on all those points now, but I think there's too many things there. The README probably be laser focused on 3-4 concise take-aways.
So, before we try and re-write it though, I'd like to try and figure out what that concise set of points should be.
Beta Was this translation helpful? Give feedback.
All reactions