From 737a0f207fdfeffa219f11b359c45a56f71a1f37 Mon Sep 17 00:00:00 2001 From: detachhead Date: Mon, 15 Jan 2024 20:58:25 +1000 Subject: [PATCH] add some stuff to the readme --- README.md | 13 +++++++++++-- 1 file changed, 11 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 7c0958354..b8df8c303 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,15 @@ -![Pyright](https://github.com/microsoft/pyright/blob/main/docs/img/PyrightLarge.png) +# basedpyright -# Static Type Checker for Python +basedpyright is a work-in-progress fork of pyright. the main goals of this project are to: + +* [x] allow the version of pyright used in vscode to be pinned to the same version used in your project +* [x] support a first-party command-line version hosted on pypi that comes bundled with nodejs and the pyright npm package instead of installing them on the fly +* [ ] feature-parity with [basedmypy](https://github.com/kotlinisland/basedmypy) +* [ ] fix instances where code is incorrectly labeled as unreachable + +# upstream readme + +## Static Type Checker for Python Pyright is a full-featured, standards-based static type checker for Python. It is designed for high performance and can be used with large Python source bases.