cbrnr / sleepecg

Sleep stage detection using ECG
BSD 3-Clause "New" or "Revised" License
90 stars 23 forks source link

[JOSS Review] Example usage in readme.md #174

Closed peterakirk closed 1 year ago

peterakirk commented 1 year ago

Just a final, quick comment relating to the JOSS review (https://github.com/openjournals/joss-reviews/issues/5411#issuecomment-1536077814).

You have some nicely laid out, extensive documentation on your readthedocs page. However, when going to a github page, it's nice to just see quick example usage on the repository front page (README.md). Would be great if you could consider including a few lines.