docs: modifying readme #3378
docs: modifying readme #3378
Conversation
Readme.md
Outdated
| You can easily start experimenting with Tracee using the Docker image as follows: | ||
| Either: | ||
| * [Install Tracee in your Kubernetes cluster.](https://aquasecurity.github.io/tracee/latest/getting-started/kubernetes-quickstart) | ||
| * [Experiment using the Tracee container image.](https://aquasecurity.github.io/tracee/v0.17/#quickstart) |
There was a problem hiding this comment.
the docs main page should be similar to the readme (like before)
There was a problem hiding this comment.
that's something we can change once we agree on the README change?
There was a problem hiding this comment.
ok so let's not resolve this comment
There was a problem hiding this comment.
edited the main index page to reflect the README
Readme.md
Outdated
| * Easy configuration through Tracee Policies | ||
| * Kubernetes native user experience that is targetted at cluster administrators | ||
|
|
||
| > We release new features and changes on a monthly basis. Learn more about the letest release in our [discussions.](https://github.com/aquasecurity/tracee/discussions) |
There was a problem hiding this comment.
changing it to regular
Readme.md
Outdated
|
|
||
| ## Quickstart | ||
|
|
||
| You can easily start experimenting with Tracee using the Docker image as follows: | ||
| Either: |
There was a problem hiding this comment.
If I reading this in a fresh user mindset, I'm thinking "should I click into one of these tutorials or follow the steps below?"
There was a problem hiding this comment.
made changes to the subheadings before the bullet points
Readme.md
Outdated
| You can easily start experimenting with Tracee using the Docker image as follows: | ||
| Either: | ||
| * [Install Tracee in your Kubernetes cluster.](https://aquasecurity.github.io/tracee/latest/getting-started/kubernetes-quickstart) | ||
| * [Experiment using the Tracee container image.](https://aquasecurity.github.io/tracee/v0.17/#quickstart) |
There was a problem hiding this comment.
ok so let's not resolve this comment
Readme.md
Outdated
| **Key Features:** | ||
| * Kubernetes native installation | ||
| * Hundreds of default events | ||
| * Ships with basic set of behavioral signatures for malicious detection out of the box |
There was a problem hiding this comment.
| * Ships with basic set of behavioral signatures for malicious detection out of the box | |
| * Ships with a basic set of behavioral signatures for malware detection out of the box |
|
|
||
| Tracee is an [Aqua Security](https://aquasec.com) open source project. | ||
| Learn about our open source work and portfolio [Here](https://www.aquasec.com/products/open-source-projects/). | ||
| Join the community, and talk to us about any matter in [GitHub Discussion](https://github.com/aquasecurity/tracee/discussions) or [Slack](https://slack.aquasec.com). |
There was a problem hiding this comment.
Don't you think it's a good thing to have a link to our slack channel?
There was a problem hiding this comment.
Yes, I have added it above -- just moved it around a bit
Signed-off-by: AnaisUrlichs <urlichsanais@gmail.com>
Signed-off-by: AnaisUrlichs <urlichsanais@gmail.com>
Signed-off-by: AnaisUrlichs <urlichsanais@gmail.com>
Rewriting the readme to include further information on key features and ways to get started with Tracee