From d087f40c5802dc49ade0dd4df9ea1e27eed50ddb Mon Sep 17 00:00:00 2001 From: Ondrej Rehacek Date: Wed, 6 Mar 2024 16:26:59 +0100 Subject: [PATCH] Update README.md --- README.md | 29 +++++++++++++++++++++++++++-- 1 file changed, 27 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 0b91293..db2f14d 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,27 @@ -# stash-unity -Stash experiments in Unity +# Stash for Unity + +## About + +This package is designed to get your Unity project up and running with Stash web shop in a few easy steps. Package is wrapping Stash API endpoints and is very lightweight with no external dependencies. + +## Requirements + +Stash package always targets the latest LTS version of Unity. We recommend you use the LTS version of Unity to build projects that are in production or about to ship. However, you should not encounter any issues when integrating or migrating into any other versions of Unity above the targeted release. + + +## Changelog + +Package follows Semantic Versioning `(major.minor.patch)`. Any potential breaking changes will always cause a major version increment, non-breaking new features will cause a minor version increment, and bugfixes will cause a patch version increment. +A full version changelog is available in the [changelog](/CHANGELOG.md) file. + + +## Installation + +1. Download [the latest build from the release page](https://github.com/stashgg/stash-unity/releases) +2. Import the `.unitypackage` file into your Unity game using the [local asset package import](https://docs.unity3d.com/Manual/AssetPackagesImport.html) process. +3. Optionally select the `Scenes` folder to test out our reference implementations. + + +## Feedback and troubleshooting + +- If you run into any problems or have a feature request, open up a [new issue](https://github.com/stashgg/stash-unity/issues/new) in the repository. Please follow the issue/request template. \ No newline at end of file