docs: update README, add py.typed, prepare for PyPI release

Rewrote README for assertpy2 with new badges, "What's new" section, and updated examples. Added py.typed marker, PyPI publish workflow, fixed CI branch trigger.

Author: Solganis

.github/workflows/ci.yml

@@ -2,9 +2,9 @@ name: CI
 
 on:
   push:
-    branches: [master]
+    branches: [main]
   pull_request:
-    branches: [master]
+    branches: [main]
 
 jobs:
   test:

.github/workflows/publish.yml

@@ -0,0 +1,28 @@
+name: Publish to PyPI
+
+on:
+  release:
+    types: [published]
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    environment: pypi
+    permissions:
+      id-token: write
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v6
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.14"
+
+      - name: Build
+        run: uv build
+
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1

.gitignore

@@ -20,6 +20,9 @@ dist
 # mac
 .DS_Store
 
+# venv
+.venv
+
 # IDE
 /.idea
 .vscode

CONTRIBUTING.md

@@ -1,41 +1,22 @@
 # Contributing
 
-Any contributions of docs or tests or code would be awesome.
-
-Here's how:
+Contributions of docs, tests, or code are welcome.
 
 1. Fork it
 1. Clone your fork (`git clone https://my_fork`)
 1. Create a branch (`git checkout -b my_branch`)
 1. Commit your changes (`git commit -am "added some cool feature"`)
 1. Push your branch to your fork (`git push origin my_branch`)
-1. Open a [Pull Request](http://github.com/assertpy/assertpy/pulls)
+1. Open a [Pull Request](http://github.com/Solganis/assertpy2/pulls)
 1. Respond to any questions during our review process
 
 Read more about how pulls work on GitHub's [About pull requests](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/about-pull-requests) page.
 
 ## Running the Tests
 
-Before even thinking about sending us a pull request, you must first write some tests (and
-eat some dogfood by using `assertpy` assertions in any tests you write).
-
-Our favorite python test runner is [pytest](http://pytest.org/). To run all the
-tests, just execute `py.test` in the base project folder (above the `tests/` folder)
-like this:
-
-```
-PYTHONPATH=. py.test -v tests
-```
-
-Should produce output something like this:
+Before sending a pull request, write tests (and use `assertpy2` assertions in them).
 
 ```
-===== test session starts =====
-collected 589 items
-
-tests/test_bool.py::test_is_true PASSED
-..
-tests/test_warn.py::test_failures PASSED
-
-===== 589 passed in 1.91s =====
+uv sync
+uv run pytest -v
 ```