This repository has been archived by the owner on Jan 16, 2023. It is now read-only.

write a good README file #11

Open

edrisranjbar opened this issue Aug 24, 2022 · 0 comments

Assignees

Labels

Owner

edrisranjbar commented Aug 24, 2022

we should update the readme file based and get some idea from other public opensource repos.

some of the implementations we want to add:

add a better description
add license badge
add contributes list as a table
update contributing section
improve installation guideline
add language and tech used in the project

edrisranjbar added the documentation label

edrisranjbar self-assigned this

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.