Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
Signed-off-by: Bayu Satiyo <[email protected]>
  • Loading branch information
kiraio-moe committed Oct 23, 2023
1 parent 906837e commit 9572feb
Showing 1 changed file with 21 additions and 7 deletions.
28 changes: 21 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,15 @@
# Unity Splash Screen Remover
<div align="center">
<h1 align="center">Unity Splash Screen Remover</h1>

<img alt="USSR workflow status (with event)" src="https://img.shields.io/github/actions/workflow/status/kiraio-moe/USSR/build.yml">
<img alt="USSR release" src="https://img.shields.io/github/v/release/kiraio-moe/USSR">
<img alt="USSR total downloads" src="https://img.shields.io/github/downloads/kiraio-moe/USSR/total">
<img alt="USSR Repo stars" src="https://img.shields.io/github/stars/kiraio-moe/USSR">
<img alt="USSR forks" src="https://img.shields.io/github/forks/kiraio-moe/USSR">
<img alt="USSR issues" src="https://img.shields.io/github/issues/kiraio-moe/USSR">
<img alt="USSR pull requests" src="https://img.shields.io/github/issues-pr/kiraio-moe/USSR">
<img alt="Project license" src="https://img.shields.io/github/license/kiraio-moe/USSR">
</div>

## Table of Contents

Expand Down Expand Up @@ -37,6 +48,9 @@ The tool is an implementation of the guide available at <https://github.com/kira

## Usages

> [!NOTE]
> You can find the nightly build of USSR with the latest bug fixes in the [latest runned workflow](https://github.com/kiraio-moe/USSR/actions/workflows/build.yml) artifacts.
- Download USSR from [Releases](https://github.com/kiraio-moe/USSR/releases) page.
- Run `USSR.exe` and follow the instructions.

Expand Down Expand Up @@ -70,10 +84,10 @@ The tool is an implementation of the guide available at <https://github.com/kira

USSR support the following platforms:

- PC, Mac, Linux Standalone (Support Default, LZ4 & LZ4HC compression)
- Android (Support Default, LZ4 & LZ4HC compression)
- iOS (Support Default, LZ4 & LZ4HC compression)
- WebGL (Support Default, Brotli & GZip compression)
- PC, Mac, Linux Standalone
- Android
- iOS
- WebGL

## Supported Unity Versions

Expand All @@ -88,8 +102,8 @@ If you found any bugs or have suggestions, feel free to make an Issue/Pull Reque

## Credits

- Special thanks to @nesrak1 for the @nesrak1/AssetsTools.NET library, which was instrumental in the development of this tool.
- @arti4ikmin for the guide on Android platform.
- Special thanks to [@nesrak1](https://github.com/nesrak1) for the [@nesrak1/AssetsTools.NET](https://github.com/nesrak1/AssetsTools.NET) library, which was instrumental in the development of this tool.
- [@arti4ikmin](https://github.com/arti4ikmin) for the guide on Android platform.

## License

Expand Down

0 comments on commit 9572feb

Please sign in to comment.