Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Edvinas01 committed Oct 3, 2023
1 parent 30e113b commit c53991b
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 1 deletion.
11 changes: 10 additions & 1 deletion .github/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,10 @@

Simple scene loading and management system for Unity Engine, implemented via scriptable objects.

<p align="center">
<img src="screenshot.png"/>
</p>

:warning: **Warning, this is a preview package and might change at any time!**

## Features
Expand All @@ -13,7 +17,7 @@ Simple scene loading and management system for Unity Engine, implemented via scr
- Easily load sets of scenes
- Persistent scenes
- Custom transition support
- Event-based
- Unity Event support

## Installation

Expand All @@ -23,6 +27,11 @@ This package can be installed via the Package Manager by [Installing from a Git
https://github.com/chark/scriptable-scenes.git#upm
```

Alternatively, you can also install it by adding the following line to `Packages/manifest.json`:
```text
"com.chark.scriptable-scenes": "https://github.com/chark/scriptable-scenes.git#upm"
```

## Links

- [Documentation](../Packages/com.chark.scriptable-scenes/Documentation~/README.md)
Expand Down
3 changes: 3 additions & 0 deletions .github/screenshot.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit c53991b

Please sign in to comment.