Merge pull request #147 from cert-ee/docs/readme_update

docs: README update

README.md

@@ -1,6 +1,37 @@
-# Cuckoo 3
-Cuckoo 3 is a Python 3 open source automated malware analysis system.
+# Cuckoo4 - Malware analysis tool
+<img alt="Cuckoo3 logo" src="./INSTALL/logos/cuckoo3-github-readme-logo.png"/>
 
-For setup instructions, please refer to our [documentation](https://github.com/cert-ee/cuckoo3/blob/main/docs/src/installation/cuckoo.md).
+<a href="https://badge.fury.io/py/Cuckoo3"><img src="https://badge.fury.io/py/Cuckoo3.svg" alt="PyPI version" height="24"></a>
+<img alt="GitHub License" src="https://img.shields.io/github/license/cert-ee/cuckoo3" height="24">
+<img alt="GitHub contributors" src="https://img.shields.io/github/contributors/cert-ee/cuckoo3" height="24">
+<img alt="GitHub Release" src="https://img.shields.io/github/v/release/cert-ee/cuckoo3?display_name=release&logoSize=24" height="24">
 
-This is a development version, we do not recommend its use in production.
+## About
+Cuckoo3 is an open-source tool to test suspicious files or links in a controlled
+environment.
+
+It will test them in sandboxed platform emulator(s) and generate a report, showing what the files 
+or websites did during the test.
+
+> ⚠️ You can currently only set up Cuckoo3 on Linux(Ubuntu) 
+machines and run Windows sandboxes. 
+Check our [Cuckoo3 requirements](https://cuckoo-hatch.cert.ee/static/docs/introduction/cuckoo/) 
+for more information
+
+You can see it in action at our [online Cuckoo3 Sandbox](https://cuckoo-hatch.cert.ee/).  
+For more insight into our plans, [check out our roadmap here](https://github.com/orgs/cert-ee/projects/1/views/1).
+
+
+## Quickstart
+To be added very soon.  
+
+For now, run the `install.sh` scripct to install Cuckoo3 and follow
+the instructions in documentation at 
+[Cuckoo installation](https://cuckoo-hatch.cert.ee/static/docs/installation/cuckoo/).
+
+## Next steps
+- For more indepth guides and references, please check out our [documentation](https://cuckoo-hatch.cert.ee/static/docs/)
+
+## IMPORTANT!
+**This is not a production ready solution just yet.  
+We highly advise you not to use it production environment!**