artizticamit / i-book-social-media-website-

A social media website but guess what here you will not have the info about the post origin, who has uploaded the post, but he/she is your friend, have fun finding the which friend has uploaded that post..
https://i-book-frontend.vercel.app
3 stars 8 forks source link

Enhance README file #33

Closed artizticamit closed 1 month ago

artizticamit commented 1 month ago

Need to enhance README file for this repo, so that, there are proper sections as mentioned.

  1. Project title
  2. Project description
  3. Table of contents
  4. Installation guide
  5. Features
  6. Contributing (should mention for develop branch for contributing only, no cloning or forking of master branch)
  7. Acknowledgements
JollyJolli commented 1 month ago

Hey there! Assing me please.

artizticamit commented 1 month ago

@JollyJolli , you could update it. I will review it tomorrow. Thank you for your time.

JollyJolli commented 1 month ago

Have a nice sleep!

artizticamit commented 1 month ago

Have merged those, changes, but need some changes. Needed two sections for installation guide, one for cloning and doing npm install and npm run, another cloning and doing docker build (not docker compose), could refer to previous commits changes to see the steps.

JollyJolli commented 1 month ago

Perfect, I will make it in some minutes.

artizticamit commented 1 month ago

Any update on this?

JollyJolli commented 1 month ago

i forgot ☠ I will do it rn

artizticamit commented 1 month ago

No Issue, and thanks man.