Skip to content

Commit

Permalink
chore: update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Iam1337 authored Jun 13, 2024
1 parent 3b0d244 commit 8110547
Showing 1 changed file with 59 additions and 2 deletions.
61 changes: 59 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,59 @@
# extApi
Simple Web Api for Unity
# extApi - Simple Http Server for Unity

Created by [iam1337](https://github.com/iam1337)

![](https://img.shields.io/badge/unity-2022.1%20or%20later-green.svg)
[![⚙ Build and Release](https://github.com/Iam1337/extApi/actions/workflows/ci.yml/badge.svg)](https://github.com/Iam1337/extApi/actions/workflows/ci.yml)
[![openupm](https://img.shields.io/npm/v/com.iam1337.extapi?label=openupm&registry_uri=https://package.openupm.com)](https://openupm.com/packages/com.iam1337.extapi/)
[![](https://img.shields.io/github/license/iam1337/extApi.svg)](https://github.com/Iam1337/extApi/blob/master/LICENSE)
[![semantic-release: angular](https://img.shields.io/badge/semantic--release-angular-e10079?logo=semantic-release)](https://github.com/semantic-release/semantic-release)

### Table of Contents
- [Introduction](#introduction)
- [Installation](#installation)
- [Examples](#examples)
- [Author Contacts](#author-contacts)

## Introduction
extApi - ...

### Features:

## Installation
**Old school**

Just copy the [Assets/extApi](Assets/extApi) folder into your Assets directory within your Unity project.

**OpenUPM**

Via [openupm-cli](https://github.com/openupm/openupm-cli):<br>
```
openupm add com.iam1337.extosc
```

Or if you don't have it, add the scoped registry to manifest.json with the desired dependency semantic version:
```
"scopedRegistries": [
{
"name": "package.openupm.com",
"url": "https://package.openupm.com",
"scopes": [
"com.iam1337.extapi",
]
}
],
"dependencies": {
"com.iam1337.extapi": "1.0.0"
}
```

## Examples
...

## Author Contacts
\> [telegram.me/iam1337](http://telegram.me/iam1337) <br>
\> [ext@iron-wall.org](mailto:ext@iron-wall.org)

## License
This project is under the MIT License.

0 comments on commit 8110547

Please sign in to comment.