MISC-0001 - Update readme.md with basic informations - Githubissues

zephyrsoftwares / checkflow-api

Flexible IT auditing software

0 stars 1 forks source link

MISC-0001 - Update readme.md with basic informations #2

Closed ibrahimadlani closed 9 months ago

ibrahimadlani commented 9 months ago

CheckFlow Pull Request

EARLY STEPS

[x] Have you linked this PR to its labels, project, milestone, issue ?
[x] Have you reviewed your own changes ?
[ ] Is there any break changes ?
[ ] Have you impacted the Github Actions workflow?

QUICK DESCRIPTION

Added relevant content to the readme.md

MOTIVATION

Done this in order to centralize all the useful links and documentation in the same place.

DETAILED CHANGES

Added a logo.
Added little navigation links.
Added a table of content.
Added a boilerplate project description.
Added a boilerplate contributing part.