[meom code clinic] README

[rcaneill]

This issue is open for the MEOM internal code clinic / review process

[rcaneill]

The README should include:

• [ ] The package name
• [ ] Short description of package goals.
• [ ] Package installation instructions
  • [ ] Brief demonstration of package usage (as it makes sense - links to vignettes could also suffice here if package description is clear)
• [ ] Link to your documentation website.
• [ ] If applicable, how the package compares to other similar packages and/or how it relates to other packages in the scientific ecosystem.
• [ ] Citation information

[lesommer]

[revieed by @lesommer @weisslisa @HugoJacq ]

Check list :

• name : ok
• description : ok
• installation : ok
• Link to documentation : missing
• Other package : missing
• Citation information : missing

Other improvements :

• a short visual demo with a code snippet

[lesommer]

See issues #74 #78 #77 #76

[lesommer]

Closing the code review.

[lesommer]

See above issues.