search

urmas-villem / ClusterEye

Apache License 2.0
0 stars 0 forks source link

Redesign the documentation #5

Open urmas-villem opened 9 months ago

urmas-villem commented 9 months ago

Currently the project has bad documentation. This needs a rework. Note: I can wait with this abit, just to see the application mature slightly more but eventually this needs to be addressed

urmas-villem commented 9 months ago

I like gifs inside documentation so maybe this is a way to create clear and understandable readmes? https://www.geeksforgeeks.org/how-to-add-gifs-on-readme-md-file-in-a-github-repository/ This is an example of what i mean: https://github.com/MatheusRich/end_of_life#end-of-life