21 no readme

README.md

@@ -1,2 +1,52 @@
-# Shape Shifter
+# Shape Shifter 🌗
 
+<p align="center">
+<img alt="Version" src="https://img.shields.io/github/v/tag/miniclip/shapeshifter?label=version" />
+<a href="https://github.com/miniclip/shapeshifter/issues" target="_blank">
+<img alt="GitHub issues" src ="https://img.shields.io/github/issues-raw/miniclip/shapeshifter" />
+</a>
+<a href="https://github.com/miniclip/shapeshifter/pulls" target="_blank">
+<img alt="GitHub pull requests" src ="https://img.shields.io/github/issues-pr-raw/miniclip/shapeshifter" />
+</a>
+<img alt="GitHub last commit" src ="https://img.shields.io/github/last-commit/miniclip/shapeshifter" />
+</p>
+<p align="center">
+<a href="https://github.com/miniclip/shapeshifter/blob/master/LICENSE.md" target="_blank">
+<img alt="License: MIT" src="https://img.shields.io/badge/License-MIT-blue.svg" />
+</a>
+</p>
+
+## What is ShapeShifter?
+
+ShapeShifter is a novel approach to skinning and switching between different games inside the same Unity project.
+
+By switching your skinned assets with alternate versions while maintaining its original GUID, this tool allows for multiple versions of the same assets to coexist without ever losing references.
+
+It supports the following asset types:
+- AnimationClip
+- AnimatorController
+- Folders
+- GameObject
+- MonoScript
+- Prefabs
+- SceneAsset
+- ScriptableObject
+- Shader
+- Texture2D
+- TextAsset
+
+### Caution!
+
+- This is an experimental package with no official release yet. Take into account that it might bring unexpected problems into your project. **Please make sure to backup your work before integrating ShapeShifter.**
+
+## Preview
+
+![Step 1](/Documentation~/01-SkinSprite.gif)
+![Step 2](/Documentation~/02-ReplaceVersionB.gif)
+![Step 3](/Documentation~/03-SwitchSprites.gif)
+![Step 4](/Documentation~/04-SwitchInsideScene.gif)
+
+
+## Contributing
+
+Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.