Repository template

.github_changelog_generator

@@ -0,0 +1,6 @@
+user=mob-sakai
+project=ShinyEffectForUGUI
+issues-wo-labels=false
+pr-wo-labels=false
+exclude_labels=duplicate,question,invalid,wontfix,Duplicate,Question,Invalid,Wontfix,Meta: Exclude From Changelog,unreleased
+unreleased=false

.gitignore

@@ -0,0 +1,36 @@
+[Ll]ibrary/
+[Tt]emp/
+[Oo]bj/
+[Bb]uild/
+/[Bb]uilds/
+/Assets/AssetStoreTools*
+
+# Autogenerated VS/MD solution and project files
+ExportedObj/
+*.csproj
+*.unityproj
+*.sln
+*.suo
+*.tmp
+*.user
+*.userprefs
+*.pidb
+*.booproj
+*.svd
+
+
+# Unity3D generated meta files
+*.pidb.meta
+
+# Unity3D Generated File On Crash Reports
+sysinfo.txt
+
+# Mac
+*.DS_Store
+
+# Builds
+*.apk
+
+
+# Packages
+*.unitypackage

CHANGELOG.md

@@ -0,0 +1,3 @@
+# Change Log
+
+\* *This Change Log was automatically generated by [github_changelog_generator](https://github.com/skywinder/Github-Changelog-Generator)*

LICENSE.txt

@@ -0,0 +1,7 @@
+Copyright 2018 mob-sakai
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

README.md

@@ -1,2 +1,77 @@
-# ShinyEffectForUGUI
 ShinyEffectForUGUI
+===
+
+ShinyEffectForUGUI
+
+[![](https://img.shields.io/github/release/mob-sakai/ShinyEffectForUGUI.svg?label=latest%20version)](https://github.com/mob-sakai/ShinyEffectForUGUI/release)
+[![](https://img.shields.io/github/release-date/mob-sakai/ShinyEffectForUGUI.svg)](https://github.com/mob-sakai/ShinyEffectForUGUI/releases)  
+![](https://img.shields.io/badge/requirement-Unity%205.5%2B-green.svg)
+[![](https://img.shields.io/github/license/mob-sakai/ShinyEffectForUGUI.svg)](https://github.com/mob-sakai/ShinyEffectForUGUI/blob/master/LICENSE.txt)  
+[![](https://img.shields.io/github/last-commit/mob-sakai/ShinyEffectForUGUI/develop.svg?label=last%20commit)](https://github.com/mob-sakai/ShinyEffectForUGUI/commits/develop)
+[![](https://img.shields.io/github/issues/mob-sakai/ShinyEffectForUGUI.svg)](https://github.com/mob-sakai/ShinyEffectForUGUI/issues)
+[![](https://img.shields.io/github/commits-since/mob-sakai/ShinyEffectForUGUI/latest.svg)](https://github.com/mob-sakai/ShinyEffectForUGUI/compare/master...develop)
+
+
+<< [Description](#Description) | [WebGL Demo](#demo) | [Download](https://github.com/mob-sakai/ShinyEffectForUGUI/releases) | [Usage](#usage) | [Development Note](#development-note) | [Change log](https://github.com/mob-sakai/ShinyEffectForUGUI/blob/develop/CHANGELOG.md) >>
+
+
+
+<br><br><br><br>
+## Description
+
+
+
+<br><br><br><br>
+## Demo
+
+[WebGL Demo](https://)
+
+
+
+<br><br><br><br>
+## Usage
+
+1. Download ShinyEffectForUGUI.unitypackage from [Releases](https://github.com/mob-sakai/ShinyEffectForUGUI/releases).
+1. Import the package into your Unity project. Select `Import Package > Custom Package` from the `Assets` menu.
+1. Add `ShinyEffectForUGUI` component to UI element (Image, RawImage, Text, etc...) from `Add Component` in inspector.
+1. Choose effect type and adjust values in inspector.  
+1. Enjoy!
+
+
+##### Requirement
+
+* Unity 5.5+ *(included Unity 2017.x)*
+* No other SDK are required
+
+
+
+
+<br><br><br><br>
+## Development Note
+
+#### What's doing?
+
+
+
+
+<br><br><br><br>
+## License
+
+* MIT
+* © UTJ/UCL
+
+
+
+## Author
+
+[mob-sakai](https://github.com/mob-sakai)
+
+
+
+## See Also
+
+* GitHub page : https://github.com/mob-sakai/ShinyEffectForUGUI
+* Releases : https://github.com/mob-sakai/ShinyEffectForUGUI/releases
+* Issue tracker : https://github.com/mob-sakai/ShinyEffectForUGUI/issues
+* Current project : https://github.com/mob-sakai/ShinyEffectForUGUI/projects/1
+* Change log : https://github.com/mob-sakai/ShinyEffectForUGUI/blob/master/CHANGELOG.md

package.json

@@ -0,0 +1,10 @@
+{
+  "name": "ShinyEffectForUGUI",
+  "version": "2.1.0",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/mob-sakai/ShinyEffectForUGUI.git"
+  },
+  "src": "Assets/ShinyEffectForUGUI",
+  "license": "MIT"
+}

release.sh

@@ -0,0 +1,58 @@
+#!/bin/bash -e
+
+# Release the project with the following steps:
+#   1. Update the release version in package.json.
+#   2. Update "CHANGELOG.md" using "github_changelog_generator-1.15.0.pre.rc".
+#   3. Commit package.json and CHANGELOG.md.
+#   4. Merge into master branch.
+#   5. Export unitypackage.
+#   6. Release using "gh-release-3.2.0". (Upload unitypackage)
+UNITY_PATH=/Applications/Unity5.5.0p4/Unity5.5.0p4.app/Contents/MacOS/Unity
+
+
+# input version
+PACKAGE_NAME=`node -pe 'require("./package.json").name'`
+echo Github Release: $PACKAGE_NAME
+read -p "[? release version (for example: 1.0.0): " RELEASE_VERSION
+[ -z "$RELEASE_VERSION" ] && exit
+
+
+# update version
+git checkout -B release develop
+sed -i -e "s/\"version\": \(.*\)/\"version\": \"${RELEASE_VERSION}\",/g" package.json
+
+
+# generate change log
+TAG=v$RELEASE_VERSION
+git tag $TAG
+git push --tags
+github_changelog_generator
+git tag -d $TAG
+git push --delete origin $TAG
+
+
+git diff -- CHANGELOG.md
+read -p "[? continue? (y/N):" yn
+case "$yn" in [yY]*) ;; *) exit ;; esac
+
+
+# commit files
+git add CHANGELOG.md -f
+git add package.json -f
+git commit -m "update change log"
+
+
+# merge and push
+git checkout master
+git merge --no-ff release -m "release $TAG"
+git branch -D release
+git push origin master
+
+
+# export .unitypackage and release on Github
+PACKAGE_SRC=`node -pe 'require("./package.json").src'`
+$UNITY_PATH -quit -batchmode -projectPath "`pwd`" -exportpackage $PACKAGE_SRC $PACKAGE_NAME.unitypackage
+gh-release  --draft --assets $PACKAGE_NAME.unitypackage
+
+
+echo "\n\n$PACKAGE_NAME v$RELEASE_VERSION has been successfully released!\n"