Skip to content

Commit 4c3b58e

Browse files
Update README.md
fixed broken links and added starter toolkits
1 parent a2c771d commit 4c3b58e

1 file changed

Lines changed: 19 additions & 17 deletions

File tree

README.md

Lines changed: 19 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
<div align="center">
2-
<a href="https://www.react-pdf.dev/?utm_source=github&utm_medium=referral" target="_blank">
2+
<a href="https://www.react-pdf-kit.dev/?utm_source=github&utm_medium=referral" target="_blank">
33
<picture>
44
<source srcset="./assets/img/react-pdf_cover.webp" width="100%">
55
<img alt="React PDF Kit" src="./assets/img/react-pdf_cover.webp width="100%">
@@ -94,7 +94,7 @@ If you need broader browser compatibility, you can continue using PDF.js `4.10.3
9494
| ------ | ------- | ---- | ------ | ---------- | -------------- |
9595
| 119+ | 115+ | 115+ | 17.4+ | 17.4+ | 126+ |
9696

97-
To change the version of PDF.js used, refer to [Dependency Override](/usage-guide/overriding-dependency) guide.
97+
To change the version of PDF.js used, refer to [Dependency Override](https://docs.react-pdf-kit.dev/usage-guide/overriding-dependency/) guide.
9898

9999
## 2. Install the Package
100100

@@ -151,7 +151,7 @@ The following structure demonstrates how to build a React PDF viewer by importin
151151
</RPConfig>
152152
```
153153

154-
_Remark: For more information on each component, please refer to [Component](https://docs.react-pdf.dev/components/overview?utm_source=github&utm_medium=referral)._
154+
_Remark: For more information on each component, please refer to [Component](https://docs.react-pdf-kit.dev/components/overview?utm_source=github&utm_medium=referral)._
155155

156156
### Basic Usage
157157

@@ -160,7 +160,7 @@ The most basic usage of React PDF viewer needs four components, namely: `RPConfi
160160
Here's how to implement a basic PDF viewer in a React application:
161161

162162
```jsx
163-
import { RPProvider, RPLayout, RPPages, RPConfig } from '@pdf-viewer/react'
163+
import { RPProvider, RPLayout, RPPages, RPConfig } from '@react-pdf-kit/viewer'
164164

165165
const App = () => {
166166
return (
@@ -197,19 +197,21 @@ Here are some sample projects to get started on React PDF quickly:
197197
5. [React (vite) - TypeScript - Turborepo](https://github.com/react-pdf-kit/starter-rp-react-vite-ts-turborepo)
198198
6. [Next.js - JavaScript (App Router)](https://github.com/react-pdf-kit/starter-rp-nextjs-app-router-js)
199199
7. [Next.js - TypeScript (App Router)](https://github.com/react-pdf-kit/starter-rp-nextjs-app-router-ts)
200-
8. [Next.js - TypeScript - Turborepo](https://github.com/react-pdf-kit/starter-rp-next-ts-turborepo)
201-
9. [Remix - JavaScript](https://github.com/react-pdf-kit/starter-rp-remix-js)
202-
10. [Remix - TypeScript](https://github.com/react-pdf-kit/starter-rp-remix-ts)
203-
11. [Gatsby - JavaScript](https://github.com/react-pdf-kit/starter-rp-gatsby-js)
204-
12. [Gatsby - TypeScript](https://github.com/react-pdf-kit/starter-rp-gatsby-ts)
205-
13. [Docusaurus - JavaScript](https://github.com/react-pdf-kit/starter-rp-docusaurus-js)
206-
14. [Docusaurus - TypeScript](https://github.com/react-pdf-kit/starter-rp-docusaurus-ts)
207-
15. [Electron - JavaScript](https://github.com/react-pdf-kit/starter-rp-electron-js-vite)
208-
16. [Electron - TypeScript](https://github.com/react-pdf-kit/starter-rp-electron-ts-vite)
209-
17. [TanStack - JavaScript](https://github.com/react-pdf-kit/starter-rp-tanstack-router-js)
210-
18. [TanStack - TypeScript](https://github.com/react-pdf-kit/starter-rp-tanstack-router-ts)
211-
19. [React Router - JavaScript](https://github.com/react-pdf-kit/starter-rp-react-router-js)
212-
20. [React Router - TypeScript](https://github.com/react-pdf-kit/starter-rp-react-router-ts)
200+
8. [Next.js - JavaScript (Pages Router)](https://github.com/react-pdf-kit/starter-rp-nextjs-pages-router-js)
201+
9. [Next.js - TypeScript (Pages Router)](https://github.com/react-pdf-kit/starter-rp-nextjs-pages-router-ts)
202+
10. [Next.js - TypeScript - Turborepo](https://github.com/react-pdf-kit/starter-rp-next-ts-turborepo)
203+
11. [Remix - JavaScript](https://github.com/react-pdf-kit/starter-rp-remix-js)
204+
12. [Remix - TypeScript](https://github.com/react-pdf-kit/starter-rp-remix-ts)
205+
13. [Gatsby - JavaScript](https://github.com/react-pdf-kit/starter-rp-gatsby-js)
206+
14. [Gatsby - TypeScript](https://github.com/react-pdf-kit/starter-rp-gatsby-ts)
207+
15. [Docusaurus - JavaScript](https://github.com/react-pdf-kit/starter-rp-docusaurus-js)
208+
16. [Docusaurus - TypeScript](https://github.com/react-pdf-kit/starter-rp-docusaurus-ts)
209+
17. [Electron - JavaScript](https://github.com/react-pdf-kit/starter-rp-electron-js-vite)
210+
18. [Electron - TypeScript](https://github.com/react-pdf-kit/starter-rp-electron-ts-vite)
211+
19. [TanStack - JavaScript](https://github.com/react-pdf-kit/starter-rp-tanstack-router-js)
212+
20. [TanStack - TypeScript](https://github.com/react-pdf-kit/starter-rp-tanstack-router-ts)
213+
21. [React Router - JavaScript](https://github.com/react-pdf-kit/starter-rp-react-router-js)
214+
22. [React Router - TypeScript](https://github.com/react-pdf-kit/starter-rp-react-router-ts)
213215

214216

215217
# 📝 Changelog

0 commit comments

Comments
 (0)