Skip to content

Update README.md#4393

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.

Sign up for GitHub

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

Merged
langermank merged 3 commits into from
Apr 11, 2024
Merged

Update README.md #4393

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
2a10ba5
Update README.md
maximedegreve Mar 14, 2024
4b66da5
Create ten-candles-melt.md
maximedegreve Mar 14, 2024
2dc9dcb
Update README.md
maximedegreve Mar 17, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/ten-candles-melt.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
"@primer/react": patch

@broccolinisoupbroccolinisoupMar 15, 2024

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

We usually release the docs changes without a changeset but did you want to announce this in the release notes?

@maximedegrevemaximedegreveMar 15, 2024

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

That was my plan. I was getting a warning though because there wasn't a changeset?

@broccolinisoupbroccolinisoupMar 18, 2024

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Yeah the CI job will fail if there is no changeset. You could either add a changeset like you did here or you can add skip changeset label.

---

Add our react template to the README.md
4 changes: 4 additions & 0 deletions README.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -38,6 +38,10 @@ npm install @primer/react
yarn add @primer/react
```

## Template

The fastest way make a prototype or try Primer React without setting up a new project is by using our [react template](https://github.com/primer/react-template).

## Roadmap

You can track our roadmap progress in the [Roadmap Project Board](https://github.com/primer/react/projects/3), see more detail in the [quarterly planning Discussions](https://github.com/primer/react/discussions?discussions_q=%5BRoadmap%5D), and find a [list of all the current epic tracking issues](https://github.com/primer/react/discussions/997).
Expand Down