Update README.md

README.md

@@ -1 +1,43 @@
-# textmeshpro-spriteatlas-support
+# TextMeshPro.SpriteAtlas.Support [![Github license](https://img.shields.io/github/license/codewriter-packages/textmeshpro-spriteatlas-support.svg?style=flat-square)](#) [![Unity 2021.3](https://img.shields.io/badge/Unity-2021.3+-2296F3.svg?style=flat-square)](#) ![GitHub package.json version](https://img.shields.io/github/package-json/v/codewriter-packages/textmeshpro-spriteatlas-support?style=flat-square)
+
+> [!WARNING]  
+> Package is EXPERIMENTAL and may not work.
+
+## :heavy_exclamation_mark: Requirements
+
+- SpriteAtlas **V2**
+- TextMeshPro package version **3.0.6**
+
+## :rocket: How to use?
+
+#### 1. Enable SpriteAtlas V2 in `ProjectSettings/Editor`
+
+![SpriteAtlasV2](https://github.com/codewriter-packages/textmeshpro-spriteatlas-support/assets/26966368/dbbfcd48-0962-4614-8185-d049464d3324)
+
+#### 2. Create `SpriteAtlas`
+
+![SpriteAtlas](https://github.com/codewriter-packages/textmeshpro-spriteatlas-support/assets/26966368/0fcce501-46ce-4262-a189-6c1326d257e0)
+
+#### 3. Select `SpriteAtlas` and create asset by `Create/TextMeshPro/SpriteAtlas Asset`
+
+![SpriteAtlas Asset](https://github.com/codewriter-packages/textmeshpro-spriteatlas-support/assets/26966368/2b50538c-453c-4031-aca7-e76c71b20f68)
+
+#### 4. Update generated assets with `UpdateSprites` context menu
+
+![UpdateSprites](https://github.com/codewriter-packages/textmeshpro-spriteatlas-support/assets/26966368/1b928fcf-5334-4d3b-861a-2060bde7390a)
+
+> [!IMPORTANT]  
+> SpriteAtlas Asset can be updates only in  play mode due to limitatiion of Unity
+
+#### 5. Done. Now you can use generated sprite asset in TextMeshPro
+
+![Asset](https://github.com/codewriter-packages/textmeshpro-spriteatlas-support/assets/26966368/e1deb105-ee74-4c00-a2bb-cd5901e30495)
+
+## :open_book: How to Install
+
+Library distributed as git package ([How to install package from git URL](https://docs.unity3d.com/Manual/upm-ui-giturl.html))
+<br>Git URL: `https://github.com/codewriter-packages/textmeshpro-spriteatlas-support.git`
+
+## :green_book: License
+
+TextMeshPro.SpriteAtlas.Support is [MIT licensed](./LICENSE.md).