From df309f3bd83951798223e3ac74ab6f4bd3ea33aa Mon Sep 17 00:00:00 2001 From: henribru <6639509+henribru@users.noreply.github.com> Date: Sat, 11 Nov 2023 15:43:43 +0100 Subject: [PATCH] Improve README --- README.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index b7d4b64..bb83716 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,14 @@ # Type stubs for proto-plus-stubs [![PyPI version](https://badge.fury.io/py/proto-plus-stubs.svg)](https://badge.fury.io/py/proto-plus-stubs) -This package provides type stubs for the [proto-plus](https://pypi.org/project/proto-plus/) package. +This package provides type stubs for the [proto-plus](https://pypi.org/project/proto-plus/) package. It allows you to type check usage of the library with e.g. [mypy](http://mypy-lang.org/) and will also improve autocomplete in many editors. **This is in no way affiliated with Google.** -The stubs were created automatically by [stubgen](https://mypy.readthedocs.io/en/stable/stubgen.html). +The stubs were originally created by [stubgen](https://mypy.readthedocs.io/en/stable/stubgen.html), but have seen some manual improvements since then. Further contributions are welcome. + ## Installation ```shell script $ pip install proto-plus-stubs ``` +The stubs should be automatically picked up by your editor or typechecker. \ No newline at end of file