better doc

Author: Fabien Coelho

README.md

@@ -1,4 +1,4 @@
-# FlaskTester - fixtures for Flask internal and external pytest tests
+# FlaskTester - Pytest fixtures for Flask internal and external tests
 
 This package allows to run authenticated tests against a Flask application,
 either with internal Flask tests (aka `test_client`) or external tests (with
@@ -7,6 +7,15 @@ either with internal Flask tests (aka `test_client`) or external tests (with
 Only one set of tests is needed, switching from internal to external is
 achieved through environment variables.
 
+![Status](https://github.com/zx80/flask-tester/actions/workflows/package.yml/badge.svg?branch=master&style=flat)
+![Tests](https://img.shields.io/badge/tests-2%20✓-success)
+![Coverage](https://img.shields.io/badge/coverage-0%25-success)
+![Issues](https://img.shields.io/github/issues/zx80/flask-tester?style=flat)
+![Python](https://img.shields.io/badge/python-3-informational)
+![Version](https://img.shields.io/pypi/v/FlaskTester)
+![Badges](https://img.shields.io/badge/badges-8-informational)
+![License](https://img.shields.io/pypi/l/flasktester?style=flat)
+
 ## Fixtures
 
 The package provides two fixtures:
@@ -51,12 +60,16 @@ assigning them through `os.environ`.
 
 ## Classes
 
-The implementation of these fixtures is based on four classes:
+The implementation of these fixtures is based on five classes:
 
 - `Authenticator` class to store test credentials.
 
   Use `setPass` and `setToken` to add user credentials.
 
+- `RequestFlaskResponse` class to turn a `requests` response into
+  a Flask-looking response, with the following attributes: `status_code`,
+  `data`, `text`, `headers`, `cookies`, `is_json` and `json`.
+
 - `Client` abstract class to run test, with two implementations.
 
   The class provides usual `get`, `post`… per-HTTP-method methods,
@@ -69,21 +82,30 @@ The implementation of these fixtures is based on four classes:
     otherwise allowed schemes are tried, with tokens first.
   - `status` for the expected HTTP status code.
 
+  For the check methods, the mandatory parameters are the method, the path
+  and the expected status.
+
 - `FlaskClient` implementation class for internal tests.
+
+   This class is mostly the standard `test_client` with the above parameters
+   extensions.
+
 - `RequestClient` implementation class for external (real HTTP) tests.
 
+  The path is relative to the URL provided to the constructor.
+
+
 ## TODO
 
 - API documentation generation
 - coverage tests
-- useless but decorative badges
-- pypi distribution
 
 ## Versions
 
 ### 0.10 on ?
 
 Add `FLASK_TESTER_DEFAULT` environment configuration to `ft_client`.
+Improve documentation, including incredible badges.
 
 ### 0.9 on 2024-03-11