Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add note to readme about early development and breaking changes #50

Merged
merged 2 commits into from
Jul 2, 2020
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,13 @@
QTrio - a library bringing Qt GUIs together with ``async`` and ``await`` via Trio
=================================================================================

Note:
This library is in early development. It works. It has tests. It has
documentation. Expect breaking changes as we explore a clean API. By paying this
price you get the privilege to provide feedback via
`GitHub issues <https://github.com/altendky/qtrio/issues>`__ to help shape our
future. ``:]``

The QTrio project's goal is to bring the friendly concurrency of Trio using Python's
``async`` and ``await`` syntax together with the GUI features of Qt to enable more
correct code and a more pleasant developer experience. QTrio is `permissively licensed
Expand Down