edit-pdf 0.0.0 → 0.0.1

package/README.md

@@ -1,73 +1,48 @@
-# React + TypeScript + Vite
+# edit-pdf
 
-This template provides a minimal setup to get React working in Vite with HMR and some ESLint rules.
+A powerful and flexible React PDF editor component.
 
-Currently, two official plugins are available:
+## Installation
 
-- [@vitejs/plugin-react](https://github.com/vitejs/vite-plugin-react/blob/main/packages/plugin-react) uses [Babel](https://babeljs.io/) (or [oxc](https://oxc.rs) when used in [rolldown-vite](https://vite.dev/guide/rolldown)) for Fast Refresh
-- [@vitejs/plugin-react-swc](https://github.com/vitejs/vite-plugin-react/blob/main/packages/plugin-react-swc) uses [SWC](https://swc.rs/) for Fast Refresh
+```bash
+npm install edit-pdf
+```
 
-## React Compiler
+## Usage
 
-The React Compiler is not enabled on this template because of its impact on dev & build performances. To add it, see [this documentation](https://react.dev/learn/react-compiler/installation).
+```tsx
+import { PdfEditor } from 'edit-pdf';
 
-## Expanding the ESLint configuration
+function App() {
+  return (
+    <div style={{ height: '100vh' }}>
+      <PdfEditor fileUrl="/path/to/document.pdf" />
+    </div>
+  );
+}
 
-If you are developing a production application, we recommend updating the configuration to enable type-aware lint rules:
+export default App;
+```
 
-```js
-export default defineConfig([
-  globalIgnores(['dist']),
-  {
-    files: ['**/*.{ts,tsx}'],
-    extends: [
-      // Other configs...
+## Features
 
-      // Remove tseslint.configs.recommended and replace with this
-      tseslint.configs.recommendedTypeChecked,
-      // Alternatively, use this for stricter rules
-      tseslint.configs.strictTypeChecked,
-      // Optionally, add this for stylistic rules
-      tseslint.configs.stylisticTypeChecked,
+- **View PDF**: Render PDF documents with high fidelity.
+- **Annotations**:
+  - **Highlight**: Highlight text with customizable colors.
+  - **Pen**: Freehand drawing tool.
+  - **Text**: Insert text annotations.
+  - **Shapes**: Add rectangles, circles, arrows, and lines.
+  - **Images**: Insert images into the PDF.
+- **Signatures**: Create and manage signatures.
+- **Eraser**: Remove annotations.
+- **Search**: Find text within the document.
 
-      // Other configs...
-    ],
-    languageOptions: {
-      parserOptions: {
-        project: ['./tsconfig.node.json', './tsconfig.app.json'],
-        tsconfigRootDir: import.meta.dirname,
-      },
-      // other options...
-    },
-  },
-])
-```
+## Props
 
-You can also install [eslint-plugin-react-x](https://github.com/Rel1cx/eslint-react/tree/main/packages/plugins/eslint-plugin-react-x) and [eslint-plugin-react-dom](https://github.com/Rel1cx/eslint-react/tree/main/packages/plugins/eslint-plugin-react-dom) for React-specific lint rules:
+| Prop | Type | Description |
+|------|------|-------------|
+| `fileUrl` | `string` | The URL of the PDF file to load. |
 
-```js
-// eslint.config.js
-import reactX from 'eslint-plugin-react-x'
-import reactDom from 'eslint-plugin-react-dom'
+## License
 
-export default defineConfig([
-  globalIgnores(['dist']),
-  {
-    files: ['**/*.{ts,tsx}'],
-    extends: [
-      // Other configs...
-      // Enable lint rules for React
-      reactX.configs['recommended-typescript'],
-      // Enable lint rules for React DOM
-      reactDom.configs.recommended,
-    ],
-    languageOptions: {
-      parserOptions: {
-        project: ['./tsconfig.node.json', './tsconfig.app.json'],
-        tsconfigRootDir: import.meta.dirname,
-      },
-      // other options...
-    },
-  },
-])
-```
+MIT

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "edit-pdf",
   "private": false,
-  "version": "0.0.0",
+  "version": "0.0.1",
   "type": "module",
   "main": "./dist/pdf-editor.umd.js",
   "module": "./dist/pdf-editor.js",