Update documentation

[d-schindler]

This PR is to update the documentation including the README

[codecov-commenter]

Codecov Report

Merging #57 (764b2f9) into master (403e461) will not change coverage. The diff coverage is 26.31%.

@@           Coverage Diff           @@
##           master      #57   +/-   ##
=======================================
  Coverage   48.21%   48.21%           
=======================================
  Files           8        8           
  Lines         589      589           
=======================================
  Hits          284      284           
  Misses        305      305           

Flag	Coverage Δ
pytest	48.21% <26.31%> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files	Coverage Δ
src/pygenstability/plotting.py	0.00% <0.00%> (ø)
src/pygenstability/optimal_scales.py	100.00% <100.00%> (ø)
src/pygenstability/pygenstability.py	96.24% <100.00%> (ø)

:mega: We’re building smart automated test selection to slash your CI/CD build times. Learn more

[peach-lucien]

the readme still needs the references added before merging into master I believe? or remove them from the text.

[d-schindler]

I added the references and code snippets for specifying Leiden and plotting optimal partitions in the workflow

[d-schindler]

I also changed all "vi" and "variation_information" to NVI

[arnaudon]

ok, this looks good, thanks! I'll clean it up and merge

[d-schindler]

I copied the text for the licence from Leiden Repo, not sure if this is ok

[arnaudon]

Thanks, yes, licence should be fine!