Add example to readme.

[flyte]

Please could you provide an example tox.ini to help explain how to use this plugin? I'm struggling to get tox to use pipenv instead of pip.

Cheers

[tonybaloney]

If the plugin is installed within the virtualenvironment where you are running tox, it will just automatically run.

tox --version shows currently installed plugins. 👍 for better documentation

[flyte]

I'm not sure what to put for deps since it's no longer -r requirements.txt. Will pipenv automatically use Pipfile.lock if I leave it blank?

[anubhavcodes]

I would welcome an example too. It's very confusing for the user not completely familiar with tox.

[tonybaloney]

Noted. Will work on doco. Any contributions also welcome

[ashwinvis]

If the plugin is installed within the virtualenvironment where you are running tox, it will just automatically run.

Thanks for that tip. What I also saw that if tox is a system-site-package, installing tox-pipenv in a virtualenv with access to system-site-packages won't load the plugin.

[vlcinsky]

@ashwinvis Your last comment deserves separate issue ticket.

[Peque]

@tonybaloney Friendly ping. 😇

[tonybaloney]

hello! sorry I've been travelling for a few months.

I've added a FAQ section to the README.rst file so this should answer all of the above questions.

1. Use Pipfile to specify your dependencies
2. Any tox or test specific extras should be added to deps in tox.ini