finalize changes

Author: marian-code

CODE_OF_CONDUCT.md

@@ -1,4 +1,4 @@
-# PyAction
+# PyLInt
 
 One-stop, zero-configuration GitHub Action for linting and enforcing style in Python projects.
 
@@ -8,7 +8,7 @@ One-stop, zero-configuration GitHub Action for linting and enforcing style in Py
 
 - Zero configuration based: Add a single line in your CI and done!
 - GitHub Annotations on PR: Highlights issues inline on the PR diff.
-- all of most popular community trusted linters in one place.
+- Most of the popular community trusted linters in one place.
 
 ## Linters supported
 
@@ -28,25 +28,31 @@ Basic:
 ```yml
 steps:
   - uses: actions/checkout@v1
-  - uses: rahul-deepsource/pyaction@v1.4.0
+  - uses: marian-code/python-lint-annotate@v2.0.0
 ```
 
 Options:
 
 ```yml
 steps:
   - uses: actions/checkout@v1
-  - uses: rahul-deepsource/pyaction@v1.4.0
+  - uses: marian-code/python-lint-annotate@v2.0.0
     with:
       python-root-list: "src/ tests/'*'"  # accepts wildcards bit must be enclosed in commas
       use-pycodestyle: false
       use-mypy: false
       use-vulture: true
       extra-pylint-options: "--output-format="colorized"
+      conda-python-version: "3.7"
 ```
 
-## Details
-uses conda environment with python 3.9 and lintner versions are:
+## Details
+
+Uses conda environment with user selected python version. Only python `3.6` - `3.9`
+version are tested since they are by far most common now. Other python `3.x` versions
+should also work. Any python `2.x` versions are unsupported!
+
+The lintner versions are:
 
 ```bash
 pycodestyle==2.6.0
@@ -59,15 +65,47 @@ vulture==2.3
 isort==isort-5.7.0
 ```
 
+## IMPORTANT - test environment
+
+The python version you set up in your action script with `actions/setup-python@v2`
+or by other means will not affect the linting process. The python version used by
+the lintners can be set up only by `conda-python-version` argument! This also means
+that if you modify the system conda environment it might affect the lintnig process.
+So it is best to keep the lintnig action separated from others. It is also recomended
+to run this on `ubuntu-latest`. Example:
+
+```yml
+on:
+  push:
+  pull_request:
+name: Lint Python
+jobs:
+  lintpython:
+    name: Lint Python
+    runs-on: ubuntu-20.04
+    steps:
+    - uses: actions/checkout@v1
+    - uses: marian-code/pyaction@master
+      with:
+        python-root-list: "./tests/'*'.py"
+        use-black: true
+        use-isort: true
+        use-mypy: true
+        use-pycodestyle: true
+        use-pydocstyle: true
+        extra-pycodestyle-options: "--max-line-length=88"
+        use-pylint: false
+        use-flake8: false
+        use-vulture: true
+        conda-python-version: "3.8"
+```
+
+
+
 ## License
 
 The scripts and documentation in this project are released under the [MIT License](LICENSE)
 
 ## Contributions
 
-Contributions are welcome! See [CONTRIBUTING.md](CONTRIBUTING.md)
-
-## Thanks to
-
-- Ricardo Baltazar Chaves' [python-lint](https://github.com/ricardochaves/python-lint) which was used as a starting point for this project.
-- Florian Bruhin who provided most of the regular expressions for problem matchers.
+Contributions are welcome through PRs.