Merge pull request #3 from datreeio/review-oss-readiness

docs: update OSS related docs

.github/ISSUE_TEMPLATE/bug_report.md

@@ -1,21 +1,11 @@
----
-name: Bug report
-about: Create a report to help us improve
-title: ''
-labels: bug
-assignees: ''
-
----
-
 **Describe the bug**
 A clear and concise description of what the bug is.
 
 **To Reproduce**
 Steps to reproduce the behavior:
-1. Go to '...'
+1. Run command '...'
 2. Click on '....'
-3. Scroll down to '....'
-4. See error
+3. See error
 
 **Expected behavior**
 A clear and concise description of what you expected to happen.
@@ -24,7 +14,7 @@ A clear and concise description of what you expected to happen.
 If applicable, add screenshots to help explain your problem.
 
 **Desktop (please complete the following information):**
- - OS: [e.g. iOS]
+ - OS: [e.g. Linux]
 
 **Additional context**
 Add any other context about the problem here.

CONTRIBUTING.md

@@ -50,7 +50,7 @@ We understand that sometimes it might be hard to extract essential bits of code
 
 Unfortunately, we are not able to investigate / fix bugs without a minimal reproduction, so if we don't hear back from you, we are going to close an issue that doesn't have enough info to be reproduced.
 
-You can file new issues by selecting from our [new issue templates](https://github.com/datreeio/datree/blob/issues-template/.github/ISSUE_TEMPLATE/bug_report.md) and filling out the issue template.
+You can file new issues by selecting from our [new issue templates](https://github.com/datreeio/datree/issues/new/choose) and filling out the issue template.
 
 
 ### <a name="submit-pr"></a> Submitting a Pull Request (PR)
@@ -152,4 +152,4 @@ The following documents can help you sort out issues with GitHub accounts and mu
   * https://help.github.com/articles/setting-your-commit-email-address-in-git/
   * https://stackoverflow.com/questions/37245303/what-does-usera-committed-with-userb-13-days-ago-on-github-mean
   * https://help.github.com/articles/about-commit-email-addresses/
-  * https://help.github.com/articles/blocking-command-line-pushes-that-expose-your-personal-email-address/
+  * https://help.github.com/articles/blocking-command-line-pushes-that-expose-your-personal-email-address/

README.md

@@ -1,17 +1,43 @@
-[![datree-logo](https://raw.githubusercontent.com/datreeio/datree/master/images/datree_LOGO-180px.png)](#) 
+[![datree-logo](https://raw.githubusercontent.com/datreeio/datree/main/images/datree_LOGO-180px.png)](#) 
 
 ![Travis (.com) branch](https://img.shields.io/travis/com/datreeio/datree/staging?label=build-staging)
 ![Travis (.com) branch](https://img.shields.io/travis/com/datreeio/datree/main?label=build-main)
 ![open issues](https://img.shields.io/github/issues-raw/datreeio/datree)
 [![HitCount](http://hits.dwyl.com/datreeio/datree.svg)](http://hits.dwyl.com/datreeio/datree)
 
-# Prevent Kubernetes misconfigurations from ever making it to production
+## What is Datree?
+[Datree](https://datree.io/?utm_source=github&utm_medium=organic_oss) helps to prevent Kubernetes misconfigurations from ever making it to production.  
 
+The CLI integration provides policies enforcement solution for Kubernetes to run automatic checks on every pull request for rule violations and misconfigurations. When rule violations are found, Datree prevents merging and shows the developer instructions to understand and fix the issue inside the CI process.  
 
-## Support
+## Quick start in two steps
+#### 1. Install the latest release on your CLI  
+**MacOS:** ``curl https://get.datree.io | /bin/sh``  
+**Linux:** ``curl https://get.datree.io/install-linux.sh | /bin/sh``  
+**Windows:** ``not supported yet :(``  
+
+#### 2. Pass datree a Kuberntes manifest file
+``datree test <k8s-manifest-file>``  
+
+...and voilà, you just made your first invocation! 🥳    
+In your CLI, you will see something like that:  
+[![datree-cli-output](https://raw.githubusercontent.com/datreeio/datree/main/images/CLI-output.png)](#) 
 
-[Datree](https://bridgecrew.io/?utm_source=github&utm_medium=organic_oss) builds and maintains this project to make Kubernetes policies simple and accessible. 
+#### Ready to review our "Getting Started" guide?
+All the information that is needed to explore a bunch of other cool feature, or how to set up your policy, can be found in [**our docs**](https://hub.datree.io/getting-started/?utm_source=github&utm_medium=organic_oss).
 
-Start with our [documentation](https://hub.datree.io/?utm_source=github&utm_medium=organic_oss) for quick tutorials and examples.
+## Built-in rules
+Right now, there are 30 battle-tested rules for you to choose from.  
+The rules are covering different Kubernetes resources/use-cases:
+* [Workload](https://hub.datree.io/workload/?utm_source=github&utm_medium=organic_oss)
+* [CronJob](https://hub.datree.io/cronjob/?utm_source=github&utm_medium=organic_oss)
+* [Containers](https://hub.datree.io/containers/?utm_source=github&utm_medium=organic_oss)
+* [Networking](https://hub.datree.io/networking/?utm_source=github&utm_medium=organic_oss)
+* [Deprecation](https://hub.datree.io/deprecation/?utm_source=github&utm_medium=organic_oss)
+* [Other](https://hub.datree.io/other/?utm_source=github&utm_medium=organic_oss)
+
+## Support
 
-If you need direct support you can contact us at support@datree.io.
+[Datree](https://datree.io/?utm_source=github&utm_medium=organic_oss) builds and maintains this project to make Kubernetes policies simple and accessible.  
+Start with our [documentation](https://hub.datree.io/?utm_source=github&utm_medium=organic_oss) for quick tutorials and examples.  
+If you need direct support you can contact us at support@datree.io.