universalviewer/README.md

The Universal Viewer is a community-developed open source project on a mission to help you share your 📚📜📰📽️📻🗿 with the 🌎

<p align="center">
<img src="https://avatars0.githubusercontent.com/u/9430521" style="width: 150px;" />
<h1 align="center" style="width: 60%; margin-left: auto; margin-right: auto;">Universal Viewer</h1>
<p align="center">
A community-developed open source project on a mission<br/> to help you share your 📚📜📰📽️📻🗿 with the 🌎
</p>
</p>
<br/>
<p align="center">
<a href="#-sponsors"><a href="https://opencollective.com/universalviewer/sponsors">
  <img src="https://opencollective.com/universalviewer/sponsors/badge.svg" alt="Sponsors on Open Collective" />
</a>
<a href="https://app.netlify.com/sites/uv/deploys">
<img src="https://api.netlify.com/api/v1/badges/91dc58e8-49dd-495f-98bb-84570a0edb7c/deploy-status" />
</a>
<a href="https://github.com/UniversalViewer/universalviewer/blob/main/LICENSE.txt">
  <img src="https://img.shields.io/npm/l/universalviewer.svg" alt="License" />
</a>
</p>
<p align="center"><a href="https://docs.google.com/forms/d/e/1FAIpQLSeHLD0kng5aXvGFsNN_tJGsZMTnp08Hv2F6kdGsJRb6bT0NWw/viewform" rel="nofollow"><strong>#</strong> Slack
</a> &nbsp;&nbsp;&nbsp;&nbsp;<a href="https://bsky.app/profile/universalviewer.io"> <strong>@</strong> Bluesky</a> &nbsp;&nbsp;&nbsp;&nbsp;<a href="https://x.com/universalviewer"> <strong>@</strong> X</a> &nbsp;&nbsp;&nbsp;&nbsp; <a href="https://github.com/UniversalViewer/universalviewer/wiki"> About </a> </p>

<br/>

    npm install universalviewer --save

<br/>
    
> Please note that UV v4 is designed to work on [evergreen browsers](https://www.w3.org/2001/tag/doc/evergreen-web/). If you need IE11 support, please use [UV v3](https://github.com/UniversalViewer/universalviewer/tree/v3).
> Microsoft no longer supports IE11, and it [reached end-of-life on June 15 2022](https://blogs.windows.com/windowsexperience/2021/05/19/the-future-of-internet-explorer-on-windows-10-is-in-microsoft-edge/).

<br/>

- [**Website**](#-website)
- [**Getting Started**](#-getting-started)
- [**Contributing**](#-contributing)
- [**Sponsors**](#-sponsors)
- [**License**](#-license)
- [**Accessibility Statement**](#-accessibility-statement)
- [**Feedback**](#-feedback)

## 🌐 Website

- [Visit Universal Viewer website](https://universalviewer.io/)
- [Visit the stable UV demo page](https://uv-v4.netlify.app) to try out the latest stable version of the Viewer (UV4) with sample items.
- [Visit the dev branch UV demo page](https://universalviewer.dev) to try out the latest 'bleeding edge' dev branch code for UV4.
- [View sample items in version 3 of the Universal Viewer](https://uv-v3.netlify.app)

## 📖 Getting Started

See the [examples](https://github.com/UniversalViewer/universalviewer/wiki/UV-Examples) for how to use the UV in various scenarios.

Read the technical [docs](https://docs.universalviewer.io/modules.html) to learn more about the code and available configuration options.

## 💻 Contributing

Read below to learn how to take part in improving the UV:

- Fork the repository and [run the examples from source](#-getting-started)
- Get familiar with [Code of Conduct](https://github.com/UniversalViewer/universalviewer/blob/dev/CODE_OF_CONDUCT.md)
- Read our [guide to contributing](https://github.com/UniversalViewer/universalviewer/blob/dev/CONTRIBUTING.md)
- Read our [governance document](https://github.com/UniversalViewer/universalviewer/blob/dev/GOVERNANCE.md) to learn more about roles and responsibilities, support, membership, and the decision making process.
- Find an [issue](https://github.com/UniversalViewer/universalviewer/issues) to work on and submit a pull request
- Could not find an issue? Look for bugs, typos, and missing features.

![Contributors](https://raw.githubusercontent.com/UniversalViewer/assets/master/contributors.jpg "Contributors")

<a href="https://github.com/UniversalViewer/universalviewer/graphs/contributors"><img src="https://opencollective.com/universalviewer/contributors.svg?width=890&button=false" /></a>

## 🏅 Sponsors

[Become a sponsor](https://opencollective.com/universalviewer#sponsor) and join our [Steering Group](https://github.com/UniversalViewer/universalviewer/wiki/Steering-Group) to help guide how our sponsorship funds are allocated.

## 📖 License

The Universal Viewer is released under the [MIT license](https://github.com/UniversalViewer/universalviewer/blob/master/LICENSE.txt).

## 📖 Accessibility Statement

Read our [Accessibility Statement](https://github.com/UniversalViewer/universalviewer/wiki/Accessibility-Statement-for-the-Universal-Viewer)

## 📣 Feedback

Read below how to engage with the UV [community](https://github.com/UniversalViewer/universalviewer/blob/dev/COMMUNITY_TEAM.md):

- Join the discussion on [Slack](http://universalviewer.io/#contact).
- Ask a question, request a new feature and file a bug with [GitHub issues](https://github.com/universalviewer/universalviewer/issues/new).
- Star the repository to show your support ⭐