I added a "Requirements" section. What other requirements are there? OS, software, disk space, etc.
It might be helpful to add a little more to the description of what the SDK does. I'm assuming some devs won't find this through our website but might stumble across it in Github.
I didn't add a "Known Issues" section because I didn't know if we needed it. Are there any known issues with this version that devs should be aware of?
If there will be future versions of this SDK, are we going to build it to be backwards compatible with anything the devs would have a dependency to in this version? (hopefully this makes sense, haha).
There are a lot of different tests for this SDK (awesome!). Do we need more notes about how, when, etc people could or should run these tests?
There is a missing example in the "Example" section. Should we re-name it to "Functionality" or something similar? Could we provide more than one example or is that necessary?
Some notes to consider for the readme:
I added a "Requirements" section. What other requirements are there? OS, software, disk space, etc.
It might be helpful to add a little more to the description of what the SDK does. I'm assuming some devs won't find this through our website but might stumble across it in Github.
I didn't add a "Known Issues" section because I didn't know if we needed it. Are there any known issues with this version that devs should be aware of?
If there will be future versions of this SDK, are we going to build it to be backwards compatible with anything the devs would have a dependency to in this version? (hopefully this makes sense, haha).
There are a lot of different tests for this SDK (awesome!). Do we need more notes about how, when, etc people could or should run these tests?
There is a missing example in the "Example" section. Should we re-name it to "Functionality" or something similar? Could we provide more than one example or is that necessary?