Update documents.

Author: chantera

.github/ISSUE_TEMPLATE.md

@@ -1,107 +1,21 @@
 # python-lsp-isort
 
-isort plugin for the Python LSP Server
+[isort](https://github.com/PyCQA/isort) plugin for the [Python LSP Server](https://github.com/python-lsp/python-lsp-server).
 
-This is a plugin for [Python LSP Server](https://github.com/python-lsp/python-lsp-server).
+## Install
 
-## Installation
+In the same `virtualenv` as `python-lsp-server`:
 
-To use this plugin, you need to install this plugin in the same virtualenv as python-lsp-server itself.
-
-``` bash
+```shell
 pip install python-lsp-isort
 ```
 
-Then run `python-lsp-server` as usual, the plugin will be auto-discovered by
-`python-lsp-server` if you've installed it to the right environment. Refer to
-`python-lsp-server` and your IDE/text editor documentation on how to setup
-`python-lsp-server`.
-
 ## Configuration
 
-... TODO ...
-
-## Features
-
-This plugin adds the following features to `pylsp`:
-
-- ... TODO ...
-
-## Developing
-
-Install development dependencies with (you might want to create a virtualenv first):
-
-``` bash
-git clone https://github.com/chantera/python-lsp-isort python-lsp-isort
-cd python-lsp-isort
-pip install -e '.[dev]'
-```
-
-### Enabling logging
-
-To enable logging in pylsp:
-
-    pylsp -v --log-file /tmp/pylsp.log
-
-### Enabling tcp mode
-
-Normally, editors communicate with language servers through standard
-input/output. Optionally, you can run pylsp in tcp mode if you want to be able
-to use the standard input/output, for example so you can use IPython or pudb,
-using the --tcp flag:
-
-    pylsp -v --log-file /tmp/pylsp.log --tcp --port 7090
-
-Consult your lsp client documentation on how to connect to tcp-mode language
-server, but if it doesn't support connecting to a language server via TCP, then
-usually can configure `netcat`/`nc` to be your "language server" that will
-proxy requests to a tcp-mode language server:
-
-    nc localhost 7090
-
-TODO: document how to connect to pylsp via pylsp from LSP clients.
-### Testing 
-
-Run `pytest` to run plugin tests.
-
-
-## Publishing
-
-If this is your first time publishing to PyPI, follow the instruction at [Twine
-docs](https://packaging.python.org/guides/distributing-packages-using-setuptools/#create-an-account)
-to create an PyPI account and setup Twine.
-
-1. Update version number in `setup.cfg`.
-
-2. Build a package using setuptools:
-
-``` bash
-python -m build
-twine check dist/*
-```
-
-3. Tag the release:
-
-```
-git tag --sign 0.1.3
-git push origin 0.1.3
-```
-
-4. Then upload using Twine:
-
-```
-twine upload --sign dist/*
-```
-
-Alternatively, you may want to upload to Test PyPI first before going live:
-
-```
-twine upload --repository testpypi dist/*
-```
+The plugin follows [python-lsp-server's configuration](https://github.com/python-lsp/python-lsp-server/#configuration).
+These are the valid configuration keys:
 
-## Credits
+- `pylsp.plugins.isort.enabled`: boolean to enable/disable the plugin. `true` by default.
+- `pylsp.plugins.isort.*`: any other key-value pair under `pylsp.plugins.isort` is passed to `isort.settings.Config`. See the [reference](https://pycqa.github.io/isort/reference/isort/settings.html#config) for details.
 
-This package was created with
-[Cookiecutter](https://github.com/audreyr/cookiecutter) from 
-[python-lsp/cookiecutter-pylsp-plugin](https://github.com/python-lsp/cookiecutter-pylsp-plugin)
-project template.
+Note that any configurations passed to isort via `pylsp` will override the settings in a config file, such as `pyproject.toml`.