Skip to content
This repository has been archived by the owner on Jun 16, 2024. It is now read-only.

Update README file #1

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Update README file #1

wants to merge 2 commits into from

Conversation

osakellarides
Copy link

Updated project documentation, changes described as below:

  • Added Table of Contents
  • Shortened the description and split into two categories 'Description' & 'How to Use'
  • Added 'How to Use' section to walk through how the application works. Added a more descriptive & relevant description walking through the entire application.
  • Added 'How to Contribute' section for any people who want to contribute to this project in the future.
  • Added 'Project Directory Structure' to show a simplified overview of how the project is laid out.
  • Added 'Tech Stack' section to specify any tools/libraries commonly used throughout the application.

@osakellarides
Update README.md
417da36 
Added table of Contents, Added 'How To Use' program application description, added 'How To Contribute', added layout of program structure and the tech stack used to create this application.
@osakellarides
Update README.md
40f9b48 
Added 'Tech Stack' to table of contents
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
1 participant
@osakellarides