@measured/puck 0.20.0-canary.755737e8 → 0.20.0-canary.7ccbeece

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -1,29 +1,33 @@
1
- # Puck
1
+ <br /><br /><br />
2
2
 
3
- The visual editor for React.
3
+ <div align="center">
4
4
 
5
- <p align="left">
6
- <a aria-label="NPM version" href="https://www.npmjs.com/package/@measured/puck">
7
- <img alt="" src="https://img.shields.io/npm/v/@measured/puck.svg?style=for-the-badge&labelColor=000000">
8
- </a>
9
- <a aria-label="License" href="https://github.com/measuredco/puck/blob/main/LICENSE">
10
- <img alt="" src="https://img.shields.io/npm/l/@measured/puck.svg?style=for-the-badge&labelColor=000000">
11
- </a>
12
- <a aria-label="Join the community on Discord" href="https://discord.gg/D9e4E3MQVZ">
13
- <img alt="" src="https://img.shields.io/badge/Join%20the%20Discord-blueviolet.svg?style=for-the-badge&logo=Discord&labelColor=000000&logoWidth=20">
14
- </a>
15
- <a aria-label="Browse the awesome-puck community repo" href="https://github.com/measuredco/awesome-puck">
16
- <img alt="" src="https://img.shields.io/badge/repo-awesome--puck-fc60a8.svg?style=for-the-badge&labelColor=000000&logoWidth=20">
17
- </a>
18
- </p>
5
+ <a href="https://puckeditor.com?utm_source=readme&utm_medium=code&utm_campaign=repo&utm_contents=logo">
6
+ <picture>
7
+ <source media="(prefers-color-scheme: dark)" srcset="https://res.cloudinary.com/die3nptcg/image/upload/Puck_Logo_White_RGB_j2rwgg.svg" height="100px" aria-label="Puck logo">
8
+ <img src="https://res.cloudinary.com/die3nptcg/image/upload/Puck_Logo_Black_RGB_dqsjag.svg" height="100px" aria-label="Puck logo">
9
+ </picture>
10
+ </a>
19
11
 
20
- ## Demo
12
+ _The visual editor for React_
21
13
 
22
- Visit https://demo.puckeditor.com/edit to try the demo.
14
+ [Documentation](https://puckeditor.com/docs?utm_source=readme&utm_medium=code&utm_campaign=repo&utm_contents=docs_link) • [Demo](https://demo.puckeditor.com/edit?utm_source=readme&utm_medium=code&utm_campaign=repo&utm_contents=demo_link) [Discord](https://discord.gg/V9mDAhuxyZ) [Contributing](https://github.com/puckeditor/puck/blob/main/CONTRIBUTING.md)
23
15
 
24
- ## Documentation
16
+ ⭐️ Enjoying Puck? Please [leave a star](https://github.com/puckeditor/puck)!
25
17
 
26
- Visit https://puckeditor.com to view the full documentation.
18
+ <br />
19
+
20
+ [![GIF showing a page being created in the Puck Editor, with components being added, arranged, and customized in real time](https://github.com/user-attachments/assets/25e1ae25-ca5e-450f-afa0-01816830b731)](https://demo.puckeditor.com/edit)
21
+
22
+ </div>
23
+
24
+ ## What is Puck?
25
+
26
+ Puck is a modular, open-source visual editor for React.js. You can use Puck to build custom drag-and-drop experiences with your own application and React components.
27
+
28
+ Because Puck is just a React component, it plays well with all React.js environments, including Next.js. You own your data and there’s no vendor lock-in.
29
+
30
+ Puck is also [licensed under MIT](https://github.com/puckeditor/puck?tab=MIT-1-ov-file#readme), making it suitable for both internal systems and commercial applications.
27
31
 
28
32
  ## Quick start
29
33
 
@@ -82,7 +86,7 @@ export function Page() {
82
86
 
83
87
  ## Recipes
84
88
 
85
- Use `create-puck-app` to quickly spin up a a pre-configured app based on our provided [recipes](https://github.com/measuredco/puck/tree/main/recipes):
89
+ Use `create-puck-app` to quickly spin up a a pre-configured app based on our provided [recipes](https://github.com/puckeditor/puck/tree/main/recipes):
86
90
 
87
91
  ```sh
88
92
  npx create-puck-app my-app
@@ -90,21 +94,21 @@ npx create-puck-app my-app
90
94
 
91
95
  Available recipes include:
92
96
 
93
- - [**next**](https://github.com/measuredco/puck/tree/main/recipes/next): Next.js example, using App Router and static page generation
94
- - [**remix**](https://github.com/measuredco/puck/tree/main/recipes/remix): Remix Run v2 example, using dynamic routes at root-level
95
- - [**react-router**](https://github.com/measuredco/puck/tree/main/recipes/react-router): React Router v7 app example, using dynamic routes to create pages at any level
97
+ - [**next**](https://github.com/puckeditor/puck/tree/main/recipes/next): Next.js example, using App Router and static page generation
98
+ - [**remix**](https://github.com/puckeditor/puck/tree/main/recipes/remix): Remix Run v2 example, using dynamic routes at root-level
99
+ - [**react-router**](https://github.com/puckeditor/puck/tree/main/recipes/react-router): React Router v7 app example, using dynamic routes to create pages at any level
96
100
 
97
101
  ## Community
98
102
 
99
103
  - [Discord server](https://discord.gg/D9e4E3MQVZ) for discussions
100
- - [awesome-puck](https://github.com/measuredco/awesome-puck) community repo for plugins, custom fields & more
104
+ - [awesome-puck](https://github.com/puckeditor/awesome-puck) community repo for plugins, custom fields & more
101
105
 
102
106
  ## Get support
103
107
 
104
- If you have any questions about Puck, please open a [GitHub issue](https://github.com/measuredco/puck/issues) or join us on [Discord](https://discord.gg/D9e4E3MQVZ).
108
+ If you have any questions about Puck, please open a [GitHub issue](https://github.com/puckeditor/puck/issues) or join us on [Discord](https://discord.gg/D9e4E3MQVZ).
105
109
 
106
110
  Or [book a discovery call](https://app.cal.com/chrisvxd/puck-enquiry/) for hands-on support and consultancy.
107
111
 
108
112
  ## License
109
113
 
110
- MIT © [The Puck Contributors](https://github.com/measuredco/puck/graphs/contributors)
114
+ MIT © [The Puck Contributors](https://github.com/puckeditor/puck/graphs/contributors)