Update README.md

Author: DanielNoord

README.md

@@ -8,7 +8,7 @@
 
 A tool to automatically format Python docstrings to follow recommendations from
 [`PEP 8`](https://www.python.org/dev/peps/pep-0008/) and
-[`PEP 257`](https://www.python.org/dev/peps/pep-0257/).
+[`PEP 257`](https://www.python.org/dev/peps/pep-0257/) (or other supported style guides.)
 
 See [What it does](#what-it-does) for currently supported auto-formatting.
 
@@ -19,7 +19,7 @@ This project is heavily inspired by
 
 When this project was started `docformatter` did not meet all of the requirements the
 [`pylint`](https://github.com/PyCQA/pylint) project had for its docstring formatter and
-sadly `docformatter` is now also no longer fully supported. Therefore, some contributors
+was no longer actively maintained (this has changed since then). Therefore, some contributors
 of `pylint` got together and started working on our own formatter to fulfill our needs.
 
 When asked we defined the objective of the tool as:
@@ -45,23 +45,6 @@ pip install pydocstringformatter
 [`Click here`](https://pydocstringformatter.readthedocs.io/en/latest/usage.html) for a
 full Usage overview.
 
-```shell
-usage: pydocstringformatter [-h] [-w] [--exclude EXCLUDE] [-v] [files ...]
-
-positional arguments:
-  files                 The directory or files to format.
-
-options:
-  -h, --help            show this help message and exit
-  -w, --write           Write the changes to file instead of printing the diffs to stdout.
-  --quiet               Do not print any logging or status messages to stdout.
-  -v, --version         Show version number and exit.
-  --max-line-length     The maximum docstring line length. Default set to 88.
-
-configuration:
-  --exclude EXCLUDE     A comma separated list of glob patterns of file path names not to be formatted.
-```
-
 ### Configuration
 
 Pydocstringformatter will also read any configuration added to the
@@ -77,6 +60,16 @@ exclude = "**/my_dir/**,**/my_other_dir/**"
 exclude = ["**/my_dir/**", "**/my_other_dir/**"]
 ```
 
+#### Style
+
+Pydocstringformatter can be configured to use a specific style. The default is ``pep257`` but
+we support other styles as well.
+These can also be used at the same time. For example with:
+
+```console
+pydocstringformatter --style=pep257 --style=numpydoc myfile.py
+```
+
 ## Pre-commit
 
 Pydocstringformatter can also be used as a [pre-commit hook](https://pre-commit.com).
@@ -91,77 +84,20 @@ Add the following to your `.pre-commit-config.yaml` file:
 
 ## What it does
 
-The following examples show what pydocstringformatter will pick up on. All _bad_
-examples will be rewritten to follow the _good_ patterns.
-
-**PEP 8: _Note that most importantly, the """ that ends a multiline docstring should be
-on a line by itself:_**
+The following examples show some of the changes pydocstringformatter will apply. For a full
+overview of all potential changes you can check out the [`Usage`](https://pydocstringformatter.readthedocs.io/en/latest/usage.html) page which
+shows an up to date list of all formatters and their description.
 
 ```python
 # Bad
-"""My
-multi-line docstring"""
-
-# Good
-"""My
-multi-line docstring
-"""
-```
-
-**PEP 257: _The closing quotes are on the same line as the opening quotes_**
-
-This can be enforced on multi-line docstrings with the `--summary-quotes-same-line`
-option. This behaviour is turned off by default.
-
-```python
-# Bad
-"""
-My docstring"""
-
-"""My docstring
-"""
-
-"""
-My
-multi-line docstring
-"""
-
-# With --summary-quotes-same-line
-"""
-My
-multi-line docstring
-"""
-
-# Good
-"""My docstring"""
-
-"""My docstring"""
-
-"""
-My
-multi-line docstring
-"""
-
-# With --summary-quotes-same-line
-"""My
-multi-line docstring
-"""
-```
-
-**PEP 257: _The docstring is a phrase ending in a period & Multi-line docstrings consist
-of a summary line just like a one-line docstring_**
-
-Since the first line should be a phrase or summary the first character gets capitalized.
-
-When the second line is one recurring character we consider the summary line to be a
-title as used in many Sphinx documentation schemes and do not add a period.
+'''
+my docstring'''
 
-```python
-# Bad
-"""my docstring"""
+"""    my
+multi-line docstring      """
 
-"""
-summary
+"""my title
+===========
 
 my docstring
 """
@@ -170,103 +106,29 @@ my docstring
 # Good
 """My docstring."""
 
-"""
-Summary.
-
-my docstring
+"""My
+multi-line docstring.
 """
 
 """My title
 ===========
 
 My docstring
 """
-```
-
-**PEP 257: _Multi-line docstrings consist of a summary line just like a one-line
-docstring, followed by a blank line, followed by a more elaborate description._**
 
-When the second line is one recurring character we consider the summary line to be a
-title as used in many Sphinx documentation schemes and do not add a white line.
-
-```python
+# With --summary-quotes-same-line
 # Bad
-"""Summary. Body."""
-
-"""Summary.
-Body.
 """
-
-# Good
-"""Summary.
-
-Body.
-"""
-
-"""My title
-===========
-
-My docstring
+My
+multi-line docstring
 """
-```
-
-**PEP 257: _For consistency, always use """triple double quotes""" around docstrings._**
-
-```python
-# Bad
-"My docstring"
-
-'My docstring'
-
-'''My docstring'''
-
-'''Summary.
-
-Body.
-'''
 
 # Good
-"""My docstring"""
-
-"""My docstring"""
-
-"""My docstring"""
-
-"""Summary.
-
-Body.
+"""My
+multi-line docstring
 """
 ```
 
-**_Trailing or leading whitespaces get removed as well._**
-
-```python
-# Bad
-"""  My docstring.  """
-
-"""  Summary.
-
-Body
-  """
-
-"""  My docstring.
-
-    My indented section
-"""
-
-# Good
-"""My docstring."""
-
-"""  Summary.
-
-Body
-"""
-
-"""My docstring.
-
-    My indented section
-"""
-```
 
 ## Development