Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README.md #288

Closed
wants to merge 1 commit into from
Closed
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
70 changes: 59 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,36 +2,84 @@

![Node CI](https://github.com/agentcooper/react-pdf-highlighter/workflows/Node%20CI/badge.svg)

# react-pdf-highlighter

Set of React components for PDF annotation.

Features:

<h1 align="center">react-pdf-highlighter</h1>

###

###

<div align="center">
<img src="https://img.shields.io/badge/TypeScript-3178C6?logo=typescript&logoColor=white&style=for-the-badge" height="40" alt="typescript logo" />
<img width="12" />
<img src="https://img.shields.io/badge/Vite-646CFF?logo=vite&logoColor=white&style=for-the-badge" height="40" alt="vite logo" />
<img width="12" />
<img src="https://img.shields.io/badge/Node.js-339933?logo=nodedotjs&logoColor=white&style=for-the-badge" height="40" alt="nodejs logo" />
<img width="12" />
<img src="https://img.shields.io/badge/React-61DAFB?logo=react&logoColor=black&style=for-the-badge" height="40" alt="react logo" />
</div>

###

## Project Staus
<table class="no-border">
<tr>
<td><img src="https://badgen.net/github/stars/agentcooper/react-pdf-highlighter" alt="Total Stars"/></td>
<td><img src="https://badgen.net/github/forks/agentcooper/react-pdf-highlighter" alt="Total Forks"/></td>
<td><img src="https://img.shields.io/github/last-commit/agentcooper/react-pdf-highlighter" alt="Last commit"/></td>
<td><img src="https://img.shields.io/github/issues/agentcooper/react-pdf-highlighter" alt="total issues"/></td>
<td><img src="https://img.shields.io/github/issues-pr/agentcooper/react-pdf-highlighter" alt="issues"/></td>
</tr>
</table>

## Table of Contents
- [Features](#features)
- [Prerequisites](#prerequisites)
- [Demos](#demos)
- [Live Demo](#live-demo)
- [Local Demo](#local-demo)
- [Importing CSS](#importing-css)
- [Install](#install)
- [How to use](#how-to-use)


## Features

- Built on top of PDF.js
- Text and image highlights
- Popover text for highlights
- Scroll to highlights

## Importing CSS
## Prerequisites

The bundled CSS include the CSS for pdfjs.
Before you start, ensure you have the following installed on your machine:

```tsx
import "react-pdf-highlighter/dist/style.css";
```
- **npm** (v6 or higher)
- **Git**

## Demos

## Example
### Live Demo

See demo https://agentcooper.github.io/react-pdf-highlighter/.
https://agentcooper.github.io/react-pdf-highlighter/.

To run the example app locally:
### Local Demo

```bash
npm install
npm start
```

## Importing CSS

The bundled CSS include the CSS for pdfjs.

```tsx
import "react-pdf-highlighter/dist/style.css";
```

## Install

```bash
Expand Down