This issue may be amended. It may also be processed partly in single issues if necessary.
Feature description
The README.md is already not bad, but could be greatly improved in some places:
Show a (short and concise) code example
Provide different entry points for different types of users. Especially there needs to be one entry point for users who are neither developers, nor NLP-researchers, but only want to setup an annotation workflow. (This should be as easy as possible since I have received the feedback that this process is too difficult, and we want to encourage new users to try small-text.)
Provide an overview of the current features. I am thinking of a similar table as in the small-text paper (cf. Table 1 here).
This issue may be amended. It may also be processed partly in single issues if necessary.
Feature description
The README.md is already not bad, but could be greatly improved in some places:
Motivation
--
Additional comments
--