grim/pyscovery

Cleaned up the readme

2013-04-14, Gary Kramlich
6b554c649f4e
Parents f27b545908cc
Children 987b20d04d43
Cleaned up the readme
1 files changed, 8 insertions(+), 2 deletions(-)
  • +8 -2
    README.txt
    • --- a/README.txt Sun Apr 14 02:59:08 2013 -0500
    +++ b/README.txt Sun Apr 14 02:59:18 2013 -0500
    @@ -27,9 +27,15 @@
    from plugin import Plugin
    pyscovery.add_module('plugins')
    - for plugin in pyscovery.find(Plugin, recurse=True):
    + for plugin in pyscovery.find(Plugin, True, False):
    print plugin
    -
    +
    Recursion in the filesystem is off by default, since that's the way people are
    used to. If there is enough demand, I will make it the default.
    +If you want to create instances of all the classes found instead of just
    +getting the class it self, you can use the following:
    +
    + for plugin in pyscovery.find(Plugin, True, True):
    + print plugin
    +