From 9678cdad3f3b9733a963a96880fa97fc21ad7386 Mon Sep 17 00:00:00 2001
From: Konstantin <konstantin.muenster@mail.com>
Date: Sun, 10 Dec 2023 07:41:29 +0100
Subject: [PATCH] ci(release): add permissions to workflow

---
 .github/workflows/publish.yml |  3 ++
 README.md                     | 87 ++++++++++-------------------------
 2 files changed, 27 insertions(+), 63 deletions(-)

diff --git a/.github/workflows/publish.yml b/.github/workflows/publish.yml
index d94eb95..b13d948 100644
--- a/.github/workflows/publish.yml
+++ b/.github/workflows/publish.yml
@@ -5,6 +5,9 @@ on:
     branches:
       - main
 
+permissions:
+  contents: write
+
 jobs:
   publish:
     name: Publish to npm
diff --git a/README.md b/README.md
index 7a4658a..435cf17 100644
--- a/README.md
+++ b/README.md
@@ -1,81 +1,42 @@
-# Turborepo starter
+# 🛹 Strapi Plugin Rich Text
 
-This is an official starter Turborepo.
+#### A WYSIWYG editor for your rich text fields
 
-## Using this example
+This Strapi plugin replaces the Markdown editor with a visual, easy-to-use text editor.
 
-Run the following command:
+- 🧑‍🎓 Write content without needing to know Markdown syntax.
+- 💅 Edit content visually, as in GoogleDocs or Notion.
+- 🧱 Add rich content elements, such as embedded YouTube videos.
+- 📦 Have your existing Markdown content automatically migrated.
 
-```sh
-npx create-turbo@latest
-```
-
-## What's inside?
-
-This Turborepo includes the following packages/apps:
-
-### Apps and Packages
-
-- `docs`: a [Next.js](https://nextjs.org/) app
-- `web`: another [Next.js](https://nextjs.org/) app
-- `@repo/ui`: a stub React component library shared by both `web` and `docs` applications
-- `@repo/eslint-config`: `eslint` configurations (includes `eslint-config-next` and `eslint-config-prettier`)
-- `@repo/typescript-config`: `tsconfig.json`s used throughout the monorepo
+---
 
-Each package/app is 100% [TypeScript](https://www.typescriptlang.org/).
+<img alt="strapi-rich-text-plugin" style="border-radius:5px" src="./strapi-plugin-rich-text-cover.png" width="640">
 
-### Utilities
+---
 
-This Turborepo has some additional tools already setup for you:
+## Getting Started
 
-- [TypeScript](https://www.typescriptlang.org/) for static type checking
-- [ESLint](https://eslint.org/) for code linting
-- [Prettier](https://prettier.io) for code formatting
+#### Install
 
-### Build
+```bash
+npm install strapi-plugin-rich-text
 
-To build all apps and packages, run the following command:
-
-```
-cd my-turborepo
-pnpm build
+# Rebuild your Strapi admin panel
+npm run build
 ```
 
-### Develop
-
-To develop all apps and packages, run the following command:
+After this, the `Rich Text` plugin should show up in your list of Plugins in the admin panel.
 
-```
-cd my-turborepo
-pnpm dev
-```
+---
 
-### Remote Caching
+## About
 
-Turborepo can use a technique known as [Remote Caching](https://turbo.build/repo/docs/core-concepts/remote-caching) to share cache artifacts across machines, enabling you to share build caches with your team and CI/CD pipelines.
-
-By default, Turborepo will cache locally. To enable Remote Caching you will need an account with Vercel. If you don't have an account you can [create one](https://vercel.com/signup), then enter the following commands:
-
-```
-cd my-turborepo
-npx turbo login
-```
-
-This will authenticate the Turborepo CLI with your [Vercel account](https://vercel.com/docs/concepts/personal-accounts/overview).
-
-Next, you can link your Turborepo to your Remote Cache by running the following command from the root of your Turborepo:
-
-```
-npx turbo link
-```
+<a href="https://www.buymeacoffee.com/kmuenster" target="_blank"><img src="https://cdn.buymeacoffee.com/buttons/default-orange.png" alt="Buy Me A Coffee" height="41" width="174"></a>
 
-## Useful Links
+Konstantin Münster – [konstantin.digital](https://konstantin.digital)
 
-Learn more about the power of Turborepo:
+Distributed under the [MIT](http://showalicense.com/?fullname=Konstantin+M%C3%BCnster&year=2019#license-mit) license.
+See `LICENSE` for more information.
 
-- [Tasks](https://turbo.build/repo/docs/core-concepts/monorepos/running-tasks)
-- [Caching](https://turbo.build/repo/docs/core-concepts/caching)
-- [Remote Caching](https://turbo.build/repo/docs/core-concepts/remote-caching)
-- [Filtering](https://turbo.build/repo/docs/core-concepts/monorepos/filtering)
-- [Configuration Options](https://turbo.build/repo/docs/reference/configuration)
-- [CLI Usage](https://turbo.build/repo/docs/reference/command-line-reference)
+[https://github.com/konstantinmuenster](https://github.com/konstantinmuenster)