diff --git a/README.md b/README.md index dff03c44..a80bbc36 100644 --- a/README.md +++ b/README.md @@ -1,23 +1,27 @@ -# PLANKA +
-**Project mastering driven by fun** + ![Logo](https://raw.githubusercontent.com/plankanban/planka/master/assets/logo.png) -![Version](https://img.shields.io/github/package-json/v/plankanban/planka?style=flat-square) [![Docker Pulls](https://img.shields.io/badge/docker_pulls-6M%2B-%23066da5?style=flat-square&color=red)](https://github.com/plankanban/planka/pkgs/container/planka) [![Contributors](https://img.shields.io/github/contributors/plankanban/planka?style=flat-square&color=blue)](https://github.com/plankanban/planka/graphs/contributors) [![Chat](https://img.shields.io/discord/1041440072953765979?style=flat-square&logo=discord&logoColor=white)](https://discord.gg/WqqYNd7Jvt) + # PLANKA -![Demo](https://raw.githubusercontent.com/plankanban/planka/master/assets/demo.gif) + _Project mastering driven by fun_ -[**Client demo**](https://plankanban.github.io/planka) (without server features). + ![Version](https://img.shields.io/github/package-json/v/plankanban/planka?style=flat-square) [![Docker Pulls](https://img.shields.io/badge/docker_pulls-8M%2B-%23066da5?style=flat-square&color=red)](https://github.com/plankanban/planka/pkgs/container/planka) [![Contributors](https://img.shields.io/github/contributors/plankanban/planka?style=flat-square&color=blue)](https://github.com/plankanban/planka/graphs/contributors) [![Chat](https://img.shields.io/discord/1041440072953765979?style=flat-square&logo=discord&logoColor=white)](https://discord.gg/WqqYNd7Jvt) -> ⚠️ The demo GIF and client demo are based on **v1** and will be updated soon. + [Install](https://docs.planka.cloud/docs/installation/docker/production-version/) · [Demo](https://planka.app) · [Docs](https://docs.planka.cloud/docs/welcome/) · [API](https://plankanban.github.io/planka/swagger-ui/) · [Cloud](https://planka.app/pricing) · [Pro version](https://planka.app/pro) + + ![Demo](https://raw.githubusercontent.com/plankanban/planka/master/assets/demo.gif) + +
## Key Features -- **Collaborative Kanban Boards**: Create projects, boards, lists, cards, and manage tasks with an intuitive drag-and-drop interface -- **Real-Time Updates**: Instant syncing across all users, no refresh needed -- **Rich Markdown Support**: Write beautifully formatted card descriptions with a powerful markdown editor -- **Flexible Notifications**: Get alerts through 100+ providers, fully customizable to your workflow -- **Seamless Authentication**: Single sign-on with OpenID Connect integration -- **Multilingual & Easy to Translate**: Full internationalization support for a global audience +- **Collaborative Kanban Boards:** Create projects, boards, lists, cards, and manage tasks with an intuitive drag-and-drop interface +- **Real-Time Updates:** Instant syncing across all users, no refresh needed +- **Rich Markdown Support:** Write beautifully formatted card descriptions with a powerful markdown editor +- **Flexible Notifications:** Get alerts through 100+ providers, fully customizable to your workflow +- **Seamless Authentication:** Single sign-on with OpenID Connect integration +- **Multilingual & Easy to Translate:** Full internationalization support for a global audience ## How to Deploy @@ -25,20 +29,17 @@ PLANKA is easy to install using multiple methods - learn more in the [installati For configuration and environment settings, see the [configuration section](https://docs.planka.cloud/docs/category/configuration/). -## Notes App Testing +Interested in a hosted or [Pro version](https://planka.app/pro) of PLANKA? Check out the pricing on our [website](https://planka.app/pricing). -The Notes app testing version is available across multiple platforms. +## Notes App -If you have an iOS device, you can join the TestFlight to try the app: [TestFlight](https://testflight.apple.com/join/5eJqTaJW). +A testing version of the Notes app is now available on multiple platforms: -For Windows and Android, you can find the app here: [PLANKA Notes](https://planka-notes.hillerdaniel.de). - -> ⚠️ The Notes app has currently been tested only with PLANKA v2. +- **iOS:** Join the [TestFlight](https://testflight.apple.com/join/5eJqTaJW) to try the app +- **Windows & Android:** Download the app [here](https://planka-notes.hillerdaniel.de) ## Contact -Interested in a hosted version of PLANKA? Email us at [github@planka.group](mailto:github@planka.group). - For any security issues, please do not create a public issue on GitHub - instead, report it privately by emailing [security@planka.group](mailto:security@planka.group). **Note:** We do NOT offer any public support via email, please use GitHub. @@ -49,10 +50,10 @@ For any security issues, please do not create a public issue on GitHub - instead PLANKA is [fair-code](https://faircode.io) distributed under the [Fair Use License](https://github.com/plankanban/planka/blob/master/LICENSES/PLANKA%20Community%20License%20EN.md) and [PLANKA Pro/Enterprise License](https://github.com/plankanban/planka/blob/master/LICENSES/PLANKA%20Commercial%20License%20EN.md). -- **Source Available**: The source code is always visible -- **Self-Hostable**: Deploy and host it anywhere -- **Extensible**: Customize with your own functionality -- **Enterprise Licenses**: Available for additional features and support +- **Source Available:** The source code is always visible +- **Self-Hostable:** Deploy and host it anywhere +- **Extensible:** Customize with your own functionality +- **Enterprise Licenses:** Available for additional features and support For more details, check the [License Guide](https://github.com/plankanban/planka/blob/master/LICENSES/PLANKA%20License%20Guide%20EN.md). diff --git a/assets/demo.gif b/assets/demo.gif index a1d5b7ce..7e3bf480 100644 Binary files a/assets/demo.gif and b/assets/demo.gif differ diff --git a/assets/logo.png b/assets/logo.png new file mode 100644 index 00000000..d58d40af Binary files /dev/null and b/assets/logo.png differ