Skip to content

Commit

Permalink
fix: updated readme
Browse files Browse the repository at this point in the history
  • Loading branch information
harshtalks committed Sep 25, 2024
1 parent 511702e commit e9bd93f
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 7 deletions.
8 changes: 3 additions & 5 deletions packages/tiptap-image/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
## @harshtalks/tiptap-image
# Tiptap Image Extension with Resize and Alignment

It extends tiptap image extension to support image resizing and alignment.
Existing third party/unofficial plugins are not flexible.
Expand All @@ -11,19 +11,17 @@ It supports both useEditor hook and EditorProvider from tiptap.

## Installation

Install my-project with npm
Installing the package using pnpm

```bash
pnpm add @harshtalks/tiptap-image
pnpm add @harshtalks/image-tiptap
```

You can use npm, bun, or yarn etc.

## Usage

```tsx
"use client";

import { useEditor, EditorContent } from "@tiptap/react";
import StarterKit from "@tiptap/starter-kit";
import { ImageExtension, ImageAligner } from "@harshtalks/tiptap-image";
Expand Down
11 changes: 9 additions & 2 deletions packages/tiptap-slash/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Tiptap Slash Command
# Tiptap Slash Command Extension

Simple tiptap extension for React to add notion like slash command to your project. It provides a flexible extension built on top of tiptap suggestion extension, and headless UI components built on cmdk package.

Expand All @@ -11,8 +11,15 @@ Notes:
1. Make sure to wrap your entire editor in a `SlashCmdProvider` component.
2. for keyboard navigation, provide `enableKeyboardNavigationc` in `editorProps` handleDOMEvents.

## Installation

### Usage:
Installing the package using pnpm

```bash
pnpm add @harshtalks/slash-tiptap
```

## Usage:


1. Define suggestions. Add all the commaands you want in the slash menu.
Expand Down

0 comments on commit e9bd93f

Please sign in to comment.