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 Information and Structure #950

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

rohitmitt
Copy link
Contributor

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

  • Added "MDX with Next.JS" link as a useful technology to learn before contributing.
  • Added excerpt 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
Before After

Updated README

Please follow the standard Github contributing guideline [found here](https://docs.github.com/en/get-started/quickstart/contributing-to-projects) when making a contribution.

## Building a Development Server
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not sure this change is needed, there's a line under "Running locally" that already has this info:

Note: This requires Node.js and yarn to be set up locally, see nodejs.org for more information.

@@ -1,17 +1,35 @@
# `styled-components.com`

The `styled-components` website. Built with Next.js, Preact and (of course) styled-components!
The `styled-components` website is made for documentation, showcasing, and enabling users with knowledge of the Styled Components library.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We always refer to the library as "styled-components"

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