leopardslab / clocal-gcp

🔭 Emulation engine for GCP
Apache License 2.0
67 stars 57 forks source link

ReadMe file is vague #21

Open aravindnatch opened 5 years ago

aravindnatch commented 5 years ago

The readme.me file should be more detailed. For example, instead of just listed that this is an emulation engine for GCP. You should exemplify what GCP stands for. In this case you could state it as "Emulation engine for GCP (Google Cloud Platform".

Another issue that is present in the readme.md file is the lack of detailed instructions on how to set it up. To have a pristine readme file, anyone should be able to reproduce it no matter their skill level. Also, there should be more in depth commands when for the user. Maybe a documentation table should exist on how to perform all the actions.