@vue-pdf-viewer/viewer 1.6.0-rc.0 → 1.6.0

package/README.md

@@ -1,29 +1,64 @@
-# Vue PDF Viewer
+<div align="center">
+  <a href="https://www.vue-pdf-viewer.dev/" target="_blank">
+    <picture>
+      <source srcset="https://raw.githubusercontent.com/vue-pdf-viewer/vue-pdf-viewer/main/assets/img/vue-pdf-viewer_logo_light.jpg" width="500">
+      <img alt="Vue PDF Viewer" src="https://raw.githubusercontent.com/vue-pdf-viewer/vue-pdf-viewer/main/assets/img/vue-pdf-viewer_logo_light.jpg" width="500">
+    </picture>
+  </a>
+</div>
 
-This package is a [Vue 3](https://vuejs.org/) component which is a handy way to integrate PDF viewing capabilities within your Vue or Nuxt applications.
+<h1 align="center">PDF Viewer for Vue 3</h1>
 
-### Prerequisites
+<div align="center">
+  Works seamlessly on your Vue or Nuxt websites. Customizable themes, built-in localizations and accessibility support.
+</div>  
+<br/>
 
-Here are the basic system requirements to run the Vue PDF Viewer component:
+<div align="center">
+  
+  [Vue PDF Viewer Home][vuepdfviewer] - [License](#page_facing_up-license) - [Documentation][vuepdfviewer-docs]
+  
+  Available for: Vue.js (3.0^), Nuxt (3.0^)
 
-- Vue version: >= 3.0
-- Nuxt version: >= 3.0
+[![NPM Version](https://img.shields.io/npm/v/%40vue-pdf-viewer%2Fviewer)][npm]
+[![Twitter](https://img.shields.io/twitter/follow/VuePDF?label=VuePDF&style=social)][twitter]
 
-_Remark: <br>- Vite version will affect the Vue or Nuxt version used. <br>- If using TypeScript, it requires >= TypeScript 4.6._
+</div>
 
-## Installation
+# :book: Table of Contents
 
-Install the package in your project directory with:
+1. [Why Vue PDF Viewer](#star-why-vue-pdf-viewer)
+2. [Features](#sparkles-features)
+3. [Documentation](#bookmark_tabs-documentation)
+4. [Starter Toolkit](#pushpin-starter-toolkit)
+5. [Need Help?](#raising_hand-need-help)
+6. [License](#page_facing_up-license)
+7. [Acknowledgement](#acknowledgement)
 
-```bash
-npm install @vue-pdf-viewer/viewer
-```
+# :star: Why Vue PDF Viewer
 
-## Documentation
+As developers ourselves, we faced many issues such as browser incompatibility and customizability while working with PDF libraries. Vue PDF Viewer (VPV) is created to solve these issues, and be flexible and simple to use for Vue.js developers. More importantly, we also built our technical documentation to be detailed and easy to follow along.
 
-For more details on how to usage or other technical information, please visit [https://docs.vue-pdf-viewer.dev/](https://docs.vue-pdf-viewer.dev/).
+# :sparkles: Features
 
-## Starter Toolkit
+<table>
+  <tr>
+    <td><p>1. Interactive & immersive experience</p><img src="https://raw.githubusercontent.com/vue-pdf-viewer/vue-pdf-viewer/main/assets/img/vpv-feature-interactive.png" /></td>
+    <td><p>2. Responsive display for different devices</p><img src="https://raw.githubusercontent.com/vue-pdf-viewer/vue-pdf-viewer/main/assets/img/vpv-feature-responsive.png" /></td>
+  </tr>
+  <tr>
+    <td><p>3. Customizable to your website's style</p><img src="https://raw.githubusercontent.com/vue-pdf-viewer/vue-pdf-viewer/main/assets/img/vpv-feature-customizable.png" /></td>
+    <td><p>4. Navigate across document easily</p><img src="https://raw.githubusercontent.com/vue-pdf-viewer/vue-pdf-viewer/main/assets/img/vpv-feature-navigation.png" /></td>
+  </tr>
+</table>
+
+Check out the full list of Vue PDF Viewer features [over here](https://www.vue-pdf-viewer.dev/features)
+
+# :bookmark_tabs: Documentation
+
+To explore VPV's technical information such as basic usage or component API, please feel free to explore [Docs][vuepdfviewer-docs].
+
+## :pushpin: Starter Toolkit
 
 Here are some sample projects to get started on Vue PDF Viewer quickly:
 
@@ -31,10 +66,28 @@ Here are some sample projects to get started on Vue PDF Viewer quickly:
 2. [Vue – Options API - TypeScript](https://github.com/vue-pdf-viewer/starter-vpv-options-ts)
 3. [Vue – Composition API - JavaScript](https://github.com/vue-pdf-viewer/starter-vpv-composition-js)
 4. [Vue – Options API - JavaScript](https://github.com/vue-pdf-viewer/starter-vpv-options-js)
-5. [Nuxt - TypeScript](https://github.com/vue-pdf-viewer/starter-vpv-nuxt-ts)
+5. [Vue – SSR - TypeScript](https://github.com/vue-pdf-viewer/starter-vpv-ssr-vue-ts)
+6. [Nuxt - TypeScript](https://github.com/vue-pdf-viewer/starter-vpv-nuxt-ts)
+7. [VitePress](https://github.com/vue-pdf-viewer/starter-vpv-vitepress)
+8. [Quasar](https://github.com/vue-pdf-viewer/starter-vpv-quasar)
+
+# :raising_hand: Need Help?
 
-## License
+We are more than happy to help you. If you have any questions, run into any errors or face any problems, please feel free to create an issue in [Issues](https://github.com/vue-pdf-viewer/vue-pdf-viewer/issues) or PM us directly in [Twitter][twitter]. Anything related to VPV is on the table!
+
+# :page_facing_up: License
 
 Vue PDF Viewer is distributed under our proprietary license. Please refer to our [License page](https://www.vue-pdf-viewer.dev/license-agreement) file for more details.
 
-If you would like to use Vue PDF Viewer commercially, please purchase a license from [our website](https://www.vue-pdf-viewer.dev) or reach out to us directly at [david@vue-pdf-viewer.dev](mailto:david@vue-pdf-viewer.dev).
+If you would like to use Vue PDF Viewer commercially, please purchase a license from [our website][vuepdfviewer] or reach out to us directly at [david@vue-pdf-viewer.dev](mailto:david@vue-pdf-viewer.dev).
+
+# Acknowledgement
+
+- [pdf.js](https://github.com/mozilla/pdf.js)
+- [Img Shields](https://shields.io)
+- [Vue.js](https://vuejs.org/)
+
+[twitter]: https://x.com/VuePDF
+[vuepdfviewer]: https://www.vue-pdf-viewer.dev
+[vuepdfviewer-docs]: https://docs.vue-pdf-viewer.dev
+[npm]: https://www.npmjs.com/package/@vue-pdf-viewer/viewer