Update README and CONTRIBUTING (#63)

CONTRIBUTING.md

@@ -0,0 +1,39 @@
+# How to Contribute #
+
+While we are working on NZBGet project all the time, we still would really like and need help on many areas:
+
+- Major - code contributions on features and bugs
+- Improvements in tests 
+- Improvements on documentation
+
+We entice our users to participate in the project, please don't hesitate to get involved - create a [new issue](https://github.com/nzbgetcom/nzbget/issues/new) or [pull request](https://github.com/nzbgetcom/nzbget/compare) - that would also greatly help if you'll share your usage experience.
+
+## Documentation ##
+
+Main documentation is available on the NZBGet.com website - [https://nzbget.com/documentation/](https://nzbget.com/documentation/)
+
+## Development ##
+
+NZBGet natively supports for multiple platforms and build options, so each platform has their own development documenation, including:
+
+- [General documentation, including Posix](https://github.com/nzbgetcom/nzbget/blob/develop/README)
+- [Windows](https://github.com/nzbgetcom/nzbget/blob/develop/windows/README-WINDOWS.txt)
+- [Docker](https://github.com/nzbgetcom/nzbget/blob/develop/docker/README.md)
+
+### Branches naming policy ###
+
+- `main` is a protected branch that contains only release code
+- `develop` is a protected branch for development
+- new branches should follow the following convention:
+  - `hotfix/brief-description` for any small hotfixes
+  - `feature/brief-description` for any new developments
+  - `bugfix/brief-description` for bugs
+
+### Pull requests flow for `develop` and `main` branches ### 
+
+1. For PRs targeting `develop` branch `Squash and merge` mode must be used.
+2. After merging branch to `develop`, branch must be deleted.
+3. For release PR (`develop` -> `main`) `Create a merge commit` mode must be used.
+4. After merging `develop` -> `main`, must be back merge `main` -> `develop` before any changes in `develop` branch.
+
+This flow results to the fact that in the PR to master branch we see only the squashed commits that correspond to the PRs in the develop branch in current release cycle.

README.md

@@ -2,6 +2,8 @@
 
 [![License](https://img.shields.io/badge/license-GPL-blue.svg)](http://www.gnu.org/licenses/)
 ![GitHub release (by tag)](https://img.shields.io/github/downloads/nzbgetcom/nzbget/v22.0/total?label=v22.0)
+![docker pulls](https://img.shields.io/docker/pulls/nzbgetcom/nzbget.svg)
+
 [![linux build](https://github.com/nzbgetcom/nzbget/actions/workflows/linux.yml/badge.svg?branch=main)](https://github.com/nzbgetcom/nzbget/actions/workflows/linux.yml)
 [![windows build](https://github.com/nzbgetcom/nzbget/actions/workflows/windows.yml/badge.svg?branch=main)](https://github.com/nzbgetcom/nzbget/actions/workflows/windows.yml)
 [![osx build](https://github.com/nzbgetcom/nzbget/actions/workflows/osx.yml/badge.svg)](https://github.com/nzbgetcom/nzbget/actions/workflows/osx.yml)
@@ -33,29 +35,20 @@ Please download binaries from our [releases](https://github.com/nzbgetcom/nzbget
 
 We also provide a docker image for popular architectures. [Docker readme](docker/README.md)
 
-## Building from sources
-
-Please follow [instructions](https://nzbget.com/documentation/building-development-version/) on the website 
+## Supported platforms for installers
 
-## Contribution
+`Windows`: Windows 7 and later, 32 or 64 Bit.
 
-Branches naming policy
+`Linux`: Linux kernel 2.6 and later, x86 (32 or 64 Bit), ARM 32-bit (armel armhf), ARM 64-bit (aarch64)
 
-- `main` is a protected branch that contains only release code
-- `develop` is a protected branch for development
-- new branches should follow the following convention:
-  - `hotfix/brief-description` for any small hotfixes
-  - `feature/brief-description` for any new developments
-  - `bugfix/brief-description` for bugs
+`macOS`: macOS 10.13 High Sierra and later, Intel / Apple Silicon.
 
-Pull requests flow for `develop` and `main` branches:
+## Building from sources
 
-1. For PRs targeting `develop` branch `Squash and merge` mode must be used.
-2. After merging branch to `develop`, branch must be deleted.
-3. For release PR (`develop` -> `main`) `Create a merge commit` mode must be used.
-4. After merging `develop` -> `main`, must be back merge `main` -> `develop` before any changes in `develop` branch.
+Please follow [instructions](https://nzbget.com/documentation/building-development-version/) on the website 
 
-This flow results to the fact that in the PR to master branch we see only the squashed commits that correspond to the PRs in the develop branch in current release cycle.
+## Contribution
 
+Contributions are very welcome - not only from developers, but from our users too - please don't hesitate to participate in [discussions](https://github.com/nzbgetcom/nzbget/discussions) or [create a new discussion](https://github.com/nzbgetcom/nzbget/discussions/new/choose) 
 
-We entice our users to participate in the project, please don't hesitate to get involved - create a [new issue](https://github.com/nzbgetcom/nzbget/issues/new) or [pull request](https://github.com/nzbgetcom/nzbget/compare)!
+For more information - see [Contributing](CONTRIBUTING.md).