Merge pull request #8 from SimformSolutionsPvtLtd/feature/update-read-me

README and Code structure updated

Author: bhargavbajani-simformsolutions

CONTRIBUTING.md

@@ -0,0 +1,8 @@
+# Way to contribute
+
+1. Fork the repo and create your branch from `master`.
+2. Clone the project to your own machine. (Please have a look at __[README](README.md#installation)__ to understand how to run this project on your machine)
+3. Commit changes to your own branch
+4. Make sure your code lints.
+5. Push your work back up to your fork.
+6. Issue that pull request!

README.md

@@ -1 +1,63 @@
-# SS-iOS-Animations
+![Banner](SSSwiftUIAnimations/Banner/Banner.png)
+
+# SS-iOS-Animations
+
+SwiftUI animation library to bring your app to life. ✨
+
+[![swiftUI](https://img.shields.io/badge/-swiftUI-blue)](https://developer.apple.com/documentation/swiftui)
+[![swift](https://img.shields.io/badge/-swift-blue)](https://developer.apple.com/swift/)
+[![swiftUI Animations](https://img.shields.io/badge/-animations-blue)](https://developer.apple.com/documentation/swiftui/animations)
+[![Twitter](https://img.shields.io/badge/Twitter-@simform-blue.svg?style=flat)](https://twitter.com/simform)
+
+🚀  **SS-iOS-Animations**: Turn ordinary user interfaces into extraordinary experiences! With this library, you can make your app more fun
+    and engaging by adding smooth and eye-catching animations to your app. Whether you're new to SwiftUI or a pro, our easy-to-use animations make it
+    simple to add that extra wow factor to your app. Spice up your app with cool transitions, fun effects, and interactive touches, all thanks to
+    **SS-iOS-Animations**. Try it out and take your SwiftUI apps to the next level! ✨
+    
+   [Check out the Examples](SSSwiftUIAnimations/Examples)
+
+## Animations
+
+### ProgressView ⏳ 
+![ProgressView](SSSwiftUIAnimations/GIFs/ProgressView.gif)
+
+[**Code Link**](SSSwiftUIAnimations/Sources/ProgressAnimation)
+
+### Left Right ArrowView ↔
+![LRArrowView](SSSwiftUIAnimations/GIFs/LRArrowView.gif)
+
+[**Code Link**](SSSwiftUIAnimations/Sources/ArrowLeftRightAnimation)
+
+## Found these animations useful? :heart:
+
+Support it by joining [stargazers] :star: for this repository.
+
+## How to Contribute :handshake:
+
+Whether you're helping us fix bugs, improve the docs, or a feature request, we'd love to have you! :muscle: \
+Check out our __[Contributing Guide]__ for ideas on contributing.
+
+## Bugs and Feedback
+
+For bugs, feature feature requests, and discussion use [GitHub Issues].
+
+## Checkout our Other Mobile Libraries
+
+Check out our other libraries [Awesome-Mobile-Libraries].
+
+## License
+
+Distributed under the MIT license. See [LICENSE] for details.
+
+
+<!-- Reference links -->
+
+[stargazers]:               https://github.com/SimformSolutionsPvtLtd/SS-iOS-Animations/stargazers
+
+[Contributing Guide]:       CONTRIBUTING.md
+
+[Awesome-Mobile-Libraries]: https://github.com/SimformSolutionsPvtLtd/Awesome-Mobile-Libraries
+
+[Github Issues]:            https://github.com/SimformSolutionsPvtLtd/SS-iOS-Animations/issues
+
+[license]:                  LICENSE

SSSwiftUIAnimations/SSSwiftUIAnimations.xcodeproj/project.pbxproj renamed to SSSwiftUIAnimations.xcodeproj/project.pbxproj

@@ -16,6 +16,8 @@
 		B10677FE2BE8D0D400957B4E /* DownArrow.swift in Sources */ = {isa = PBXBuildFile; fileRef = B10677FD2BE8D0D400957B4E /* DownArrow.swift */; };
 		B1098E7D2BD94ED900BC19DD /* WaveView.swift in Sources */ = {isa = PBXBuildFile; fileRef = B1098E7C2BD94ED900BC19DD /* WaveView.swift */; };
 		B11B983A2BCE9C3F00D76016 /* CheckView.swift in Sources */ = {isa = PBXBuildFile; fileRef = B11B98392BCE9C3F00D76016 /* CheckView.swift */; };
+		B1343F722C060680009ACE90 /* ProgressView.gif in Resources */ = {isa = PBXBuildFile; fileRef = B1343F712C060680009ACE90 /* ProgressView.gif */; };
+		B1343F742C060686009ACE90 /* LRArrowView.gif in Resources */ = {isa = PBXBuildFile; fileRef = B1343F732C060686009ACE90 /* LRArrowView.gif */; };
 		B14AB36C2BC41B05004B09C4 /* ProgressView.swift in Sources */ = {isa = PBXBuildFile; fileRef = B14AB36B2BC41B05004B09C4 /* ProgressView.swift */; };
 		B153FD0C2BFB3C1800AEFE83 /* LRArrowAnimStyle.swift in Sources */ = {isa = PBXBuildFile; fileRef = B153FD0B2BFB3C1800AEFE83 /* LRArrowAnimStyle.swift */; };
 		B153FD0E2BFB566000AEFE83 /* ExampleListRow.swift in Sources */ = {isa = PBXBuildFile; fileRef = B153FD0D2BFB566000AEFE83 /* ExampleListRow.swift */; };
@@ -28,6 +30,7 @@
 		B19E0B662BF7498700E65974 /* ExampleProgressView.swift in Sources */ = {isa = PBXBuildFile; fileRef = B19E0B652BF7498700E65974 /* ExampleProgressView.swift */; };
 		B1DFCA512BF4FA3D00F01505 /* ProgressCircle.swift in Sources */ = {isa = PBXBuildFile; fileRef = B1DFCA502BF4FA3D00F01505 /* ProgressCircle.swift */; };
 		B1DFCA532BF4FC7900F01505 /* ArrowView.swift in Sources */ = {isa = PBXBuildFile; fileRef = B1DFCA522BF4FC7900F01505 /* ArrowView.swift */; };
+		B1EA09DE2C11A6B70024BC28 /* Banner.png in Resources */ = {isa = PBXBuildFile; fileRef = B1EA09DD2C11A6B70024BC28 /* Banner.png */; };
 		B1FE861E2BFF6BC000FB111C /* ViewExtension.swift in Sources */ = {isa = PBXBuildFile; fileRef = B1FE861D2BFF6BC000FB111C /* ViewExtension.swift */; };
 /* End PBXBuildFile section */
 
@@ -42,6 +45,8 @@
 		B10677FD2BE8D0D400957B4E /* DownArrow.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = DownArrow.swift; sourceTree = "<group>"; };
 		B1098E7C2BD94ED900BC19DD /* WaveView.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = WaveView.swift; sourceTree = "<group>"; };
 		B11B98392BCE9C3F00D76016 /* CheckView.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = CheckView.swift; sourceTree = "<group>"; };
+		B1343F712C060680009ACE90 /* ProgressView.gif */ = {isa = PBXFileReference; lastKnownFileType = image.gif; path = ProgressView.gif; sourceTree = "<group>"; };
+		B1343F732C060686009ACE90 /* LRArrowView.gif */ = {isa = PBXFileReference; lastKnownFileType = image.gif; path = LRArrowView.gif; sourceTree = "<group>"; };
 		B14AB36B2BC41B05004B09C4 /* ProgressView.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = ProgressView.swift; sourceTree = "<group>"; };
 		B153FD0B2BFB3C1800AEFE83 /* LRArrowAnimStyle.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = LRArrowAnimStyle.swift; sourceTree = "<group>"; };
 		B153FD0D2BFB566000AEFE83 /* ExampleListRow.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = ExampleListRow.swift; sourceTree = "<group>"; };
@@ -54,6 +59,7 @@
 		B19E0B652BF7498700E65974 /* ExampleProgressView.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = ExampleProgressView.swift; sourceTree = "<group>"; };
 		B1DFCA502BF4FA3D00F01505 /* ProgressCircle.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = ProgressCircle.swift; sourceTree = "<group>"; };
 		B1DFCA522BF4FC7900F01505 /* ArrowView.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = ArrowView.swift; sourceTree = "<group>"; };
+		B1EA09DD2C11A6B70024BC28 /* Banner.png */ = {isa = PBXFileReference; lastKnownFileType = image.png; path = Banner.png; sourceTree = "<group>"; };
 		B1FE861D2BFF6BC000FB111C /* ViewExtension.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = ViewExtension.swift; sourceTree = "<group>"; };
 /* End PBXFileReference section */
 
@@ -87,10 +93,11 @@
 		2BC2D8F128CF3A6F00CAB302 /* SSSwiftUIAnimations */ = {
 			isa = PBXGroup;
 			children = (
-				B14AB36A2BC40286004B09C4 /* ProgressAnimation */,
-				469963A3290FCE1900DC01AD /* ArrowLeftRightAnimation */,
+				B1DE99D72C060E1A006995FB /* Sources */,
 				2BC2D8F228CF3A6F00CAB302 /* SSSwiftUIAnimationsApp.swift */,
 				B153FD112BFB64BE00AEFE83 /* Examples */,
+				B1EA09DC2C11A68A0024BC28 /* Banner */,
+				B1343F702C06064B009ACE90 /* GIFs */,
 				2BC2D8F428CF3A6F00CAB302 /* ContentView.swift */,
 				2BC2D8F628CF3A7000CAB302 /* Assets.xcassets */,
 				2BC2D8F828CF3A7000CAB302 /* Preview Content */,
@@ -118,6 +125,15 @@
 			path = ArrowLeftRightAnimation;
 			sourceTree = "<group>";
 		};
+		B1343F702C06064B009ACE90 /* GIFs */ = {
+			isa = PBXGroup;
+			children = (
+				B1343F712C060680009ACE90 /* ProgressView.gif */,
+				B1343F732C060686009ACE90 /* LRArrowView.gif */,
+			);
+			path = GIFs;
+			sourceTree = "<group>";
+		};
 		B14AB36A2BC40286004B09C4 /* ProgressAnimation */ = {
 			isa = PBXGroup;
 			children = (
@@ -143,6 +159,23 @@
 			path = Examples;
 			sourceTree = "<group>";
 		};
+		B1DE99D72C060E1A006995FB /* Sources */ = {
+			isa = PBXGroup;
+			children = (
+				B14AB36A2BC40286004B09C4 /* ProgressAnimation */,
+				469963A3290FCE1900DC01AD /* ArrowLeftRightAnimation */,
+			);
+			path = Sources;
+			sourceTree = "<group>";
+		};
+		B1EA09DC2C11A68A0024BC28 /* Banner */ = {
+			isa = PBXGroup;
+			children = (
+				B1EA09DD2C11A6B70024BC28 /* Banner.png */,
+			);
+			path = Banner;
+			sourceTree = "<group>";
+		};
 		B1F9ED332BFCD85000189871 /* ExamplesList */ = {
 			isa = PBXGroup;
 			children = (
@@ -212,7 +245,10 @@
 			buildActionMask = 2147483647;
 			files = (
 				2BC2D8FA28CF3A7000CAB302 /* Preview Assets.xcassets in Resources */,
+				B1343F722C060680009ACE90 /* ProgressView.gif in Resources */,
+				B1EA09DE2C11A6B70024BC28 /* Banner.png in Resources */,
 				2BC2D8F728CF3A7000CAB302 /* Assets.xcassets in Resources */,
+				B1343F742C060686009ACE90 /* LRArrowView.gif in Resources */,
 			);
 			runOnlyForDeploymentPostprocessing = 0;
 		};