Skip to content

Commit cd102e3

Browse files
committed
docs: clean up README structure and wording
1 parent 53c21cd commit cd102e3

1 file changed

Lines changed: 6 additions & 18 deletions

File tree

‎README.md‎

Lines changed: 6 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -9,9 +9,11 @@ Maintained fork of [assertpy](https://github.com/assertpy/assertpy). Fluent asse
99
[![License](https://img.shields.io/github/license/Solganis/assertpy2)](https://github.com/Solganis/assertpy2/blob/main/LICENSE)
1010

1111

12-
## Usage
12+
## Quick start
1313

14-
Just import the `assert_that` function, and away you go...
14+
```
15+
pip install assertpy2
16+
```
1517

1618
```py
1719
from assertpy2 import assert_that
@@ -23,20 +25,12 @@ def test_something():
2325
```
2426

2527

26-
27-
## Installation
28-
29-
```
30-
pip install assertpy2
31-
```
32-
33-
3428
## Why assertpy2?
3529

3630
| | assertpy | assertpy2 |
3731
|---|---|---|
3832
| Maintained | Last release 2020 | Active |
39-
| Python | 2.7+ | 3.10+ |
33+
| Python | 2.7+ | 3.10-3.14 |
4034
| Type safety | No annotations | `Self` return types, `py.typed` (PEP 561) |
4135
| IDE support | No type info | Full autocomplete and chaining inference |
4236
| Security | [CVE in snapshots](https://github.com/assertpy/assertpy/issues/156) | Fixed |
@@ -70,13 +64,7 @@ assert_that('/usr/bin/python').is_readable().is_executable()
7064

7165

7266

73-
## Docs
74-
75-
The fluent API of `assertpy2` is designed to create compact, yet readable tests.
76-
The API has been modeled after other fluent testing APIs, especially the awesome
77-
[AssertJ](https://assertj.github.io/doc/) assertion library for Java. Everything is fully pythonic and designed to take full advantage of the dynamism in the Python runtime.
78-
79-
Examples below cover the full API.
67+
## API
8068

8169
### Strings
8270

0 commit comments

Comments
 (0)