Skip to content

Update README.md#1939

Merged
atilafassina merged 4 commits intosolidjs:mainfrom
thomasbuilds:patch-1
Aug 18, 2025
Merged

Update README.md#1939
atilafassina merged 4 commits intosolidjs:mainfrom
thomasbuilds:patch-1

Conversation

@thomasbuilds
Copy link
Copy Markdown
Contributor

@thomasbuilds thomasbuilds commented Aug 10, 2025

This pull request improves the README by enhancing its visual appeal and usability. The current README on npm is nearly empty, and the GitHub version, while functional, lacks polish. This update addresses these issues by:

  • Adding Visual Badges: Included badges for npm version, downloads, GitHub stars, Discord, and Reddit to make the project more engaging and provide quick insights into its popularity and community.
  • Improved Structure and Clarity: Rewritten content to be concise, user-friendly, and focused on key features, setup instructions, and deployment options.
  • Relocated Development Guide: Moved the detailed development setup and monorepo instructions under a "Contributing" section with a collapsible <details> tag to prioritize user-facing content.
  • Updated Installation Commands: Added the --solidstart flag for on create solid to streamline project setup.

Notes on Yarn and Monorepo Section

The monorepo and package.json workspace instructions prominently feature Yarn, but Yarn isn't included in the installation or server startup commands. This inconsistency suggests we could remove the Yarn-specific guidance entirely to align with the focus on npm, pnpm, and Bun?

@changeset-bot
Copy link
Copy Markdown

changeset-bot Bot commented Aug 10, 2025

⚠️ No Changeset found

Latest commit: 4bfd140

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@netlify
Copy link
Copy Markdown

netlify Bot commented Aug 10, 2025

Deploy Preview for solid-start-landing-page ready!

Name Link
🔨 Latest commit 4bfd140
🔍 Latest deploy log https://app.netlify.com/projects/solid-start-landing-page/deploys/6899de676ad27f00081163d0
😎 Deploy Preview https://deploy-preview-1939--solid-start-landing-page.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@pkg-pr-new
Copy link
Copy Markdown

pkg-pr-new Bot commented Aug 10, 2025

@atilafassina atilafassina enabled auto-merge (squash) August 18, 2025 07:00
@atilafassina atilafassina merged commit 5833629 into solidjs:main Aug 18, 2025
9 checks passed
@thomasbuilds thomasbuilds deleted the patch-1 branch August 18, 2025 07:32
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