update links and disclaimer

Author: montasaurus

Makefile

@@ -16,5 +16,5 @@ test: phony
 docs: phony
 	uv run --python 3.10 lazydocs \
 		--overview-file README.md \
-		--src-base-url https://github.com/rustedpy/result/blob/main/ \
+		--src-base-url https://github.com/montasaurus/result/blob/main/ \
 		./src/result

README.md

@@ -1,23 +1,17 @@
 # Result
 
-[![GitHub Workflow Status (branch)](https://img.shields.io/github/actions/workflow/status/rustedpy/result/ci.yml?branch=main)](https://github.com/rustedpy/result/actions/workflows/ci.yml?query=branch%3Amain)
-[![Coverage](https://codecov.io/gh/rustedpy/result/branch/main/graph/badge.svg)](https://codecov.io/gh/rustedpy/result)
-
 A simple Result type for Python 3 [inspired by
 Rust](https://doc.rust-lang.org/std/result/), fully type annotated.
 
-## Installation
-
-Latest release:
+> [!WARNING]
+> Forked from the original [result](https://github.com/rustedpy/result) library after it became unmaintained. This version is experimental and mainly used for my own projects--use it at your own risk!
 
-``` sh
-$ pip install result
-```
+## Installation
 
 Latest GitHub `main` branch version:
 
 ``` sh
-$ pip install git+https://github.com/rustedpy/result
+uv add git+https://github.com/montasaurus/result
 ```
 
 ## Summary
@@ -422,29 +416,6 @@ Sometimes regular `do()` can handle async values, but this error means
 you have hit a case where it does not. You should use `do_async()` here
 instead.
 
-## Contributing
-
-These steps should work on any Unix-based system (Linux, macOS, etc) with Python
-and `make` installed. On Windows, you will need to refer to the Python
-documentation (linked below) and reference the `Makefile` for commands to run
-from the non-unix shell you're using on Windows.
-
-1. Setup and activate a virtual environment. See [Python docs][pydocs-venv] for more
-   information about virtual environments and setup.
-2. Run `make install` to install dependencies
-3. Switch to a new git branch and make your changes
-4. Test your changes:
-  - `make test`
-  - `make lint`
-  - You can also start a Python REPL and import `result`
-5. Update documentation
-  - Edit any relevant docstrings, markdown files
-  - Run `make docs`
-6. Add an entry to the [changelog](./CHANGELOG.md)
-5. Git commit all your changes and create a new PR.
-
-[pydocs-venv]: https://docs.python.org/3/library/venv.html
-
 ## FAQ
 
 -   **Why should I use the `is_ok` (`is_err`) type guard function over the `is_ok` (`is_err`) method?**

docs/README.md

@@ -15,7 +15,9 @@
 
 ## Functions
 
+- [`result.as_async_generator_result`](./result.md#function-as_async_generator_result)
 - [`result.as_async_result`](./result.md#function-as_async_result): Make a decorator to turn an async function into one that returns a ``Result``.
+- [`result.as_generator_result`](./result.md#function-as_generator_result)
 - [`result.as_result`](./result.md#function-as_result): Make a decorator to turn a function into one that returns a ``Result``.
 - [`result.do`](./result.md#function-do): Do notation for Result (syntactic sugar for sequence of `and_then()` calls).
 - [`result.do_async`](./result.md#function-do_async): Async version of do. Example: