Updated README Structure and Information - Githubissues

styled-components / styled-components-website

The styled-components website and documentation

https://styled-components.com

MIT License

612 stars 436 forks source link

Updated README Structure and Information #948

Closed rohitmitt closed 1 year ago

rohitmitt commented 1 year ago

I've updated a few things regarding the README.md file.

Major Changes:

Added a Table of Contents
Added Header Building a Development Server for clarity

Changes in Header Contributing Guideline

Included "MDX with Next.JS" link as a useful technology to learn before contributing.
Added subheader for Code Formatting with prettier.

Changes in Header Folder Structure

Removed non-existent vendor/ directory for cached dependencies
Added extended descriptors (with links) for each folder.
Added links for relevant technologies in extended descriptors.

Before and After of README.md Format:

Before	After