From e1044f0398b59daf2dea03beefa00ca7c83d96b5 Mon Sep 17 00:00:00 2001 From: Harsh Date: Wed, 25 Sep 2024 16:50:55 +0530 Subject: [PATCH] fix: readme wrong package --- README.md | 13 ++++++++----- packages/tiptap-image/README.md | 4 ++-- packages/tiptap-slash/README.md | 8 ++++++-- 3 files changed, 16 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 0a6b6c2..51ac463 100644 --- a/README.md +++ b/README.md @@ -16,10 +16,10 @@ It supports both useEditor hook and EditorProvider from tiptap. ## Installation -Install my-project with npm +Install the package using pnpm ```bash - pnpm add @harshtalks/tiptap-image + pnpm add @harshtalks/image-tiptap ``` You can use npm, bun, or yarn etc. @@ -29,7 +29,7 @@ Install my-project with npm ```tsx import { useEditor, EditorContent } from "@tiptap/react"; import StarterKit from "@tiptap/starter-kit"; -import { ImageExtension, ImageAligner } from "@harshtalks/tiptap-image"; +import { ImageExtension, ImageAligner } from "@harshtalks/image-tiptap"; import "./globals.css"; import { useCallback } from "react"; @@ -106,7 +106,7 @@ Installing the package using pnpm 1. Define suggestions. Add all the commaands you want in the slash menu. ```ts -import { enableKeyboardNavigation } from "@harshtalks/tiptap-slash"; +import { enableKeyboardNavigation } from "@harshtalks/slash-tiptap"; const suggestions = createSuggestionsItems([ { @@ -143,7 +143,7 @@ const suggestions = createSuggestionsItems([ import { Slash, enableKeyboardNavigation, -} from "@harshtalks/tiptap-slash"; +} from "@harshtalks/slash-tiptap"; const editor = useEditor({ @@ -186,6 +186,9 @@ const editor = useEditor({ 3. Wrap your editor in `SlashCmdProvider` component and add `SlashCmd` component to your editor. ```tsx +import { + SlashCmd +} from "@harshtalks/slash-tiptap"; export const Editor = () => { return ( diff --git a/packages/tiptap-image/README.md b/packages/tiptap-image/README.md index 3b5e846..b1a8d94 100644 --- a/packages/tiptap-image/README.md +++ b/packages/tiptap-image/README.md @@ -19,12 +19,12 @@ Installing the package using pnpm You can use npm, bun, or yarn etc. - ## Usage +## Usage ```tsx import { useEditor, EditorContent } from "@tiptap/react"; import StarterKit from "@tiptap/starter-kit"; -import { ImageExtension, ImageAligner } from "@harshtalks/tiptap-image"; +import { ImageExtension, ImageAligner } from "@harshtalks/image-tiptap"; import "./globals.css"; import { useCallback } from "react"; diff --git a/packages/tiptap-slash/README.md b/packages/tiptap-slash/README.md index f9bdc5d..f175cce 100644 --- a/packages/tiptap-slash/README.md +++ b/packages/tiptap-slash/README.md @@ -24,7 +24,7 @@ Installing the package using pnpm 1. Define suggestions. Add all the commaands you want in the slash menu. ```ts -import { enableKeyboardNavigation } from "@harshtalks/tiptap-slash"; +import { enableKeyboardNavigation } from "@harshtalks/slash-tiptap"; const suggestions = createSuggestionsItems([ { @@ -61,7 +61,7 @@ const suggestions = createSuggestionsItems([ import { Slash, enableKeyboardNavigation, -} from "@harshtalks/tiptap-slash"; +} from "@harshtalks/slash-tiptap"; const editor = useEditor({ @@ -104,6 +104,10 @@ const editor = useEditor({ 3. Wrap your editor in `SlashCmdProvider` component and add `SlashCmd` component to your editor. ```tsx +import { + SlashCmd +} from "@harshtalks/slash-tiptap"; + export const Editor = () => { return (