Skip to content

docs: update installation options and the openupm badge #1

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.

Sign up for GitHub

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

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

docs: update installation options and the openupm badge #1

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
12 changes: 12 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,12 +1,24 @@
# Ionic ZLIB - Unity Package Manager edition

[![openupm](https://img.shields.io/npm/v/com.ionic.zlib?label=openupm&registry_uri=https://package.openupm.com)](https://openupm.com/packages/com.ionic.zlib/)

Ionic's zlib library is an often used C# library. This is simply a wrapper of the package in Unity's Package Manager format.

https://archive.codeplex.com/?p=dotnetzip

No copyright over the zlib code itself is implied or taken. All I've done is wrapped the existing code so that you can link it from Unity's Package Manager

# Add to your project

## Install via OpenUPM

The package is available on the [openupm registry](https://openupm.com). It's recommended to install it via [openupm-cli](https://github.com/openupm/openupm-cli).

```
openupm add com.ionic.zlib
```

## Install via git url
Open the manifest.json for your project and add the following entry to your list of dependencies

```"com.ionic.zlib": "https://github.com/PixelWizards/com.ionic.zlib.git",```
Expand Down