ALPHAVIO / WordNook

Dynamically updating blogging website to upload articles and blog posts on various topics, developed using ejs template engine and node js in the backend.

https://word-nook.herokuapp.com/

MIT License

81 stars 176 forks source link

Improve README #4

Closed Pranav016 closed 3 years ago

Pranav016 commented 3 years ago

About issue-

Add screenshots of the website to the README.
Add some GitHub tags and badges to beautify the README.
Add a section right above maintainer section, for the Open Source events this Project was a part of. Add first entry as JGEC Winter of Code with a short description and logo of JGEC.
Also add Mexili winter of Code for the Open Source events this Project was a part of. Add mexili logo and short description. Get info from their website.
The website has been deployed via heroku and the environment setup is for local use, update the README accordingly.

karunkarthik-git commented 3 years ago

I'd like to contribute to it as a mentee of Jwoc.

Aayush-hub commented 3 years ago

@Pranav016 Can I work on this issue?

Pranav016 commented 3 years ago

@Aayush-hub Under which program will you be contributing ? so that I can add labels.

Read the issue description for things that need to be done 👍

Aayush-hub commented 3 years ago

@Pranav016 I am working under Mwoc. I will make all the changes requested in issue description.

Pranav016 commented 3 years ago

@Pranav016 I am working under Mwoc. I will make all the changes requested in issue description.

Do one thing, instead of screenshots add a demo gif of the website to the README. Just take a screen recording of the features of the website like how to publish posts and using the dark mode etc. Convert to gif and add it to the readme. Let me know if any help needed