From 18386546b4008e79f5d9a900446a654fd299cf05 Mon Sep 17 00:00:00 2001 From: Shunsuke Shibayama Date: Wed, 18 Dec 2024 09:34:53 +0900 Subject: [PATCH] Update README.md --- README.md | 26 ++++++++++++++++++++++++++ 1 file changed, 26 insertions(+) diff --git a/README.md b/README.md index 53e3039..3d6c748 100644 --- a/README.md +++ b/README.md @@ -33,6 +33,32 @@ Make sure that `cargo`/`rustc` is up-to-date, as pylyzer may be written with the ### [GitHub Releases](https://github.com/mtshiba/pylyzer/releases/latest) +## How to use + +### Check a single file + +```sh +pylyzer file.py +``` + +### Check an entire package + +If you don't specify a file path, pylyzer will automatically search for the entry point. + +```sh +pylyzer +``` + +### Start the language server + +This option is used when an LSP-aware editor requires arguments to start pylyzer. + +```sh +pylyzer --server +``` + +For other options, check [the manual](https://mtshiba.github.io/pylyzer/options/options/). + ## What is the advantage over pylint, pyright, pytype, etc.? * Performance 🌟