Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updated README.md file to include supporting links and more detail to sections #260

Merged
merged 3 commits into from
Oct 3, 2023

Conversation

carboitel
Copy link
Contributor

This PR contains edits to the README file so that core concepts in the documentation can be more easily accessed and understood. I specifically added the following updates to help improve the documentation and contribution efforts of the program:

  • Added a table of contents
  • Updated Clendar's description to be more informative for new users
  • Added supporting links to the tech stacks
  • Created a step-by-step list of how to contribute to the application
  • Added a section of important files to navigate to
  • Updated the inspiration credits since the git page link no longer existed

@vinhnx
Copy link
Owner

vinhnx commented Oct 3, 2023

Looks really good, thank you so much @carboitel ! 🙌

@vinhnx vinhnx merged commit c3184d5 into vinhnx:main Oct 3, 2023
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants