Better presentation of how to provide bibtex for package authors

[rtavenar]

Hi,

Thanks for this package, it's great and so simple to use.

I would have one suggestion: as a package owner, it is not obvious to understand how to provide the correct bibtex for a package.

Would that make sense to add a section to the README.md that would somehow look like the following:

Example for package owner

If you own a package and would like makecite to be able to provide adequate bibtex when people use it, all you have to do is define a __bibtex__ or __citation__ variable in your package and makecite will look for it (in that order).

[bsipocz]

@rtavenar - Thanks for the feedback. We should indeed point to examples in the docs.

For now here are two:

• astropy uses a CITATION file that among others has the bibtex, and the it uses this function to provide the bibtex string as an attribute: https://github.com/astropy/astropy/blob/master/astropy/__init__.py#L264
• astroML on the other hand uses a much simpler approach: https://github.com/astroML/astroML/blob/master/astroML/__init__.py#L3

[rtavenar]

So does tslearn since today :)