diff --git a/README.md b/README.md index 17ea2ba93..9331308d0 100644 --- a/README.md +++ b/README.md @@ -1,30 +1,82 @@ -

Payload

-

A free and open-source TypeScript headless CMS & application framework built with Express, MongoDB and React.

+
+
+ +

+ + + + Payload CMS Logo + +

+ +

The most powerful TypeScript CMS

+

Code-first Headless CMS that bridges the gap between CMS and application framework

+ +

+
+ Explore the docs » +
+
+

+ +

+ Request Feature + · + Report Bug + · + Join Discord + · + Docs + · + Website +

+ +
+

+   - - npm +   + + git commit activity - - - Tweet Payload - - +   Discord +   + + npm + +   + + Payload CMS Twitter +

+
+ - Payload headless CMS Admin panel built with React + Payload headless CMS Admin panel built with React -### Features +
+ +## ⭐ Why Payload? + +Payload is a CMS that has been designed for developers from the ground up to deliver them what they need to build great digital products. If you know JavaScript, you know Payload. It's a _code-first_ CMS, which allows us to do a lot of things right: + +- Payload gives you everything you need, but then steps back and lets you build what you want in JavaScript or TypeScript - with no unnecessary complexity brought by GUIs. You'll understand how your CMS works because you will have written it exactly how you want it. +- Bring your own Express server and do whatever you need on top of Payload. Payload doesn't impose anything on you or your app. +- Completely control the Admin panel by using your own React components. Swap out fields or even entire views with ease. +- Use your data however and wherever you need thanks to auto-generated, yet fully extensible REST, GraphQL, and Local Node APIs. + +## ✨ Features - Completely free and open-source - [GraphQL](https://payloadcms.com/docs/graphql/overview), [REST](https://payloadcms.com/docs/rest-api/overview), and [Local](https://payloadcms.com/docs/local-api/overview) APIs @@ -44,41 +96,38 @@ - Intensely fast API - Highly secure thanks to HTTP-only cookies, CSRF protection, and more -### Code-first - -Payload is a CMS that has been designed for developers from the ground up to deliver them what they need to build great digital products. If you know JavaScript, you know Payload. It's a _code-first_ CMS, which allows us to do a lot of things right: - -- Payload gives you everything you need, but then steps back and lets you build what you want in JavaScript or TypeScript - with no unnecessary complexity brought by GUIs. You'll understand how your CMS works because you will have written it exactly how you want it. -- Bring your own Express server and do whatever you need on top of Payload. Payload doesn't impose anything on you or your app. -- Completely control the Admin panel by using your own React components. Swap out fields or even entire views with ease. -- Use your data however and wherever you need thanks to auto-generated, yet fully extensible REST, GraphQL, and Local Node APIs. - -### Quick Start +## 🚀 Quick Start Before beginning to work with Payload, make sure you have all of the [required software](https://payloadcms.com/docs/getting-started/installation). From there, the easiest way to get started with Payload is to use the `create-payload-app` package: -``` +```text npx create-payload-app ``` Alternatively, it only takes about five minutes to [create an app from scratch](https://payloadcms.com/docs/getting-started/installation#from-scratch). -### Documentation +## 🗒️ Documentation Check out the [Payload website](https://payloadcms.com/docs/getting-started/what-is-payload) to find in-depth documentation for everything that Payload offers. -### Contributing +## 🙋 Contributing If you want to add contributions to this repository, please follow the instructions in [contributing.md](./contributing.md). -### Other Resources +## 🚨 Need help? -##### Discussions +There are lots of good conversations and resources in our Github Discussions board & our Discord Server. If you're struggling with something, chances are, someone's already solved what you're up against. :point_down: -There are lots of good conversations and resources in our [GitHub Discussions board](https://github.com/payloadcms/payload/discussions). If you're struggling with something, chances are, someone's already solved what you're up against. Searching Discussions will often provide very helpful tips and tricks. +- [GitHub Discussions](https://github.com/payloadcms/payload/discussions) +- [GitHub Issues](https://github.com/payloadcms/payload/issues) +- [Discord](https://t.co/30APlsQUPB) -##### Discord +## ⭐ Like what we're doing? Give us a star -Join [Payload's Discord channel](https://discord.com/invite/r6sCXqVk3v) to interact with Payload developers in realtime. +![payload-github-star](https://cms.payloadcms.com/media/payload-github-star.gif) + +## 👏 Thanks to all our contributors + +