misje / opencti-wazuh-connector

OpenCTI–Wazuh connector looking for indicators in Wazuh and creating sightings
https://misje.github.io/opencti-wazuh-connector/
Apache License 2.0
10 stars 1 forks source link

Shorten README and add obvious links to installation and configuration #24

Closed misje closed 1 month ago

misje commented 1 month ago

The README was made before the documentation was even started. Rewrite the whole document and provide links to the documentation, especially to installation and configuration. Ideally create a nice gif that showcases what the connector is all about.

Most connectors are very short on documentation (or lacking any documentation whatsoever), and users, including myself, are accustomed to look for a docker-compose.yml file as a reference. This project doesn't have one, so help users navigate to the docker-compose example files and configuration reference.

misje commented 1 month ago

I added an "Installation" section, referring to the documentation. I'll leave it at that for now.