update README, add urls to pyproject.toml

Author: jhossbach

README.md

@@ -1,2 +1,38 @@
 # python-lsp-ruff
+
+[![PyPi](https://img.shields.io/pypi/v/python-lsp-ruff.svg)](https://pypi.org/project/python-lsp-ruff/1.0.0/)
+[![Python](https://github.com/python-lsp/python-lsp-ruff/actions/workflows/python.yml/badge.svg)](https://github.com/python-lsp/python-lsp-ruff/actions/workflows/python.yml)
+
 Linter plugin for pylsp based using ruff.
+Formatting via `ruff`'s `--fix` option will be available soon.
+
+## Install
+
+In the same `virtualenv` as `python-lsp-server`:
+
+```shell
+pip install python-lsp-ruff
+```
+
+# Usage
+
+This plugin will disable `flake8` and `pycodestyle` by default.
+When enabled, all linting diagnostics will be provided by `ruff`.
+
+# Configuration
+
+Configuration options can be passed to the python-language-server. If a `pyproject.toml`
+file is present in the project, `python-lsp-ruff` will use these configuration options.
+
+The plugin follows [python-lsp-server's
+configuration](https://github.com/python-lsp/python-lsp-server/#configuration). These are
+the valid configuration keys:
+
+ - `pylsp.plugins.ruff.enabled`: boolean to enable/disable the plugin. `true` by default.
+ - `pylsp.plugins.ruff.config`: Path to optional `pyproject.toml` file.
+ - `pylsp.plugins.ruff.exclude`: Exclude files from being checked by `ruff`.
+ - `pylsp.plugins.ruff.executable`: Path to the `ruff` executable. Assumed to be in PATH by default.
+ - `pylsp.plugins.ruff.ignore`: Error codes to ignore.
+ - `pylsp.plugins.ruff.lineLength`: Set the line-length for length checks.
+ - `pylsp.plugins.ruff.perFileIgnores`: File-specific error codes to be ignored.
+ - `pylsp.plugins.ruff.select`: List of error codes to enable.

pyproject.toml

@@ -24,6 +24,10 @@ dev = ["pytest", "pre-commit"]
 [project.entry-points.pylsp]
 pylsp_ruff = "pylsp_ruff.ruff_lint"
 
+[project.urls]
+"Homepage" = "https://github.com/python-lsp/python-lsp-ruff"
+"Bug Tracker" = "https://github.com/python-lsp/python-lsp-ruff/issues"
+
 [tool.pytest.ini_options]
 pythonpath = ["."]