Improved documentation

[xmatthias]

I think this is a great library - however documentation is somewhat lacking.

I've been able to build up a rather nice workflow now - but most of it i had to piece together from the sourcecode.

Mainly, it's about the configuration dictionary way:

from questionary import Separator, prompt
questions = [
        {
            "type": "confirm",
            "name": "conditional_step",
            "message": "Would you like the next question?",
            "default": True,
        },
       {
            "type": "text",
            "name": "next_question",
            "message": "Name this library?",
            "when": lambda x: x['conditional_step'],
            "validate": lambda val: val == "questionary"
        },
       {
            "type": "select",
            "name": "second_question",
            "message": "Select item",
            "choices": [
                "item1",
                "item2",
                Separator(),
                "other",
            ],
        },
        {
            "type": "text",
            "name": "second_question",
            "message": "Insert free text",
            "when": lambda x: x["second_question"] == "other"
        },
]
prompt(questions)

For the above dictionary - the following points are missing / non-obvious in the docs

• "validate": key name when used as dictionary
• `"validate": can be a function, does not have to be a ValidatorClass
• "when": conditional - the readme.md only points this out as "skipif"
• "second_question": Names can be reused in this way, to offer "choices" - or a "other" - free text form - which will end in the same dictionary key - "second_question" in the above example.

While the examples cover some of this - i think it would be better to have these very cool and important features documented properly.

[tmbo]

@xmatthias that is great feedback, thanks a lot. Given that your experience is still fresh, do you mind proposing the changes to the Readme?

Maybe pointing towards the examples more could help (and adding more comments in there)

[xmatthias]

I guess i'll close this as #38 has been merged - and it includes what i personally was missing (not sure if other things are missing too).