intermediate: readme and documentation maintenance

README.md

@@ -1,44 +1,51 @@
-> Licensed under the Apache License, Version 2.0 (the \"License\"); you
-> may not use this file except in compliance with the License. You may
-> obtain a copy of the License at
->
-> <http://www.apache.org/licenses/LICENSE-2.0>
->
-> Unless required by applicable law or agreed to in writing, software
-> distributed under the License is distributed on an \"AS IS\" BASIS,
-> WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
-> implied. See the License for the specific language governing
-> permissions and limitations under the License.
-
-# Json Preprocessor\'s Package Description
+# Package description for JsonPreprocessor
 
 ## Getting Started
 
-The JsonPreprocessor is a Python3 package which allows programmers to
-handle additional features in json files such as
+The JsonPreprocessor is a Python3 package which provides additional
+features for JSON files.
 
--   add comments
--   import other json files
--   overwrite already existing parameters with new values
+These are:
 
-These json files will be handled by the JsonPreprocessor which returns
-as result a dictionary object of the deserialized data.
+-   (nested) import of other json files.
+-   overwrite already existing parameters with new values from later
+    loaded json files.
+-   accept `True`, `False` and `None` as data types.
+-   support for comments.
+
+The JsonPreprocessor returns as result a dictionary object of the
+deserialized preprocessed data.
 
 ## How to install
 
-Firstly, clone **python-jsonpreprocessor** repository to your machine.
+**JsonPreprocessor** can be installed in two different ways.
+
+1.  Installation via PyPi (recommended for users)
+
+    ``` 
+    pip install JsonPreprocessor
+    ```
+
+    [JsonPreprocessor in
+    PyPi](https://pypi.org/project/JsonPreprocessor/)
+
+2.  Installation via GitHub (recommended for developers)
+
+    Clone the **python-jsonpreprocessor** repository to your machine.
+
+    ``` 
+    git clone https://github.com/test-fullautomation/python-jsonpreprocessor.git
+    ```
 
-Then go to python-jsonpreprocessor, using the 2 common commands below to
-build or install this package:
+    [JsonPreprocessor in
+    GitHub](https://github.com/test-fullautomation/python-jsonpreprocessor)
 
-``` 
-setup.py build      will build the package underneath 'build/'
-setup.py install    will install the package
-```
+    Use the following command to install **JsonPreprocessor**:
 
-After the build processes is completed, the package is located in
-\'build/\', and the generated package documentation is located in
-\'doc/\_build/\'.
+    ``` 
+    cd python-jsonpreprocessor
+    setup.py install
+    ```
 
 ## Package Documentation
 

README.rst

@@ -1,47 +1,65 @@
 .. Copyright 2020-2022 Robert Bosch GmbH
 
-   Licensed under the Apache License, Version 2.0 (the "License");
+.. Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.
    You may obtain a copy of the License at
 
-   http://www.apache.org/licenses/LICENSE-2.0
+.. http://www.apache.org/licenses/LICENSE-2.0
 
-   Unless required by applicable law or agreed to in writing, software
+.. Unless required by applicable law or agreed to in writing, software
    distributed under the License is distributed on an "AS IS" BASIS,
    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    See the License for the specific language governing permissions and
    limitations under the License.
 
-Json Preprocessor's Package Description
-=======================================
+Package description for JsonPreprocessor
+========================================
 
 Getting Started
 ---------------
 
-The JsonPreprocessor is a Python3 package which allows programmers to handle  
-additional features in json files such as
+The JsonPreprocessor is a Python3 package which provides additional features for
+JSON files.
 
-* add comments
-* import other json files
-* overwrite already existing parameters with new values
+These are:
 
-These json files will be handled by the JsonPreprocessor which returns as result
-a dictionary object of the deserialized data.
+* (nested) import of other json files.
+* overwrite already existing parameters with new values from later loaded json files.
+* accept ``True``, ``False`` and ``None`` as data types.
+* support for comments.
+
+The JsonPreprocessor returns as result a dictionary object of the deserialized 
+preprocessed data.
 
 How to install
 --------------
 
-Firstly, clone **python-jsonpreprocessor** repository to your machine.
+**JsonPreprocessor** can be installed in two different ways.
+
+1. Installation via PyPi (recommended for users)
+
+   .. code::
+
+      pip install JsonPreprocessor
+
+   `JsonPreprocessor in PyPi <https://pypi.org/project/JsonPreprocessor/>`_
+
+2. Installation via GitHub (recommended for developers)
+
+   Clone the **python-jsonpreprocessor** repository to your machine.
+
+   .. code::
+
+      git clone https://github.com/test-fullautomation/python-jsonpreprocessor.git
 
-Then go to python-jsonpreprocessor, using the 2 common commands below to build or install this package:
+   `JsonPreprocessor in GitHub <https://github.com/test-fullautomation/python-jsonpreprocessor>`_
 
-.. code-block::
+   Use the following command to install **JsonPreprocessor**:
 
-    setup.py build      will build the package underneath 'build/'
-    setup.py install    will install the package
+   .. code::
 
-After the build processes is completed, the package is located in 'build/', and the generated 
-package documentation is located in 'doc/_build/'.
+      cd python-jsonpreprocessor
+      setup.py install
 
 
 Package Documentation