fixed readme and project struct

shakurocom · Sep 30, 2022 · 7bb2f6b · 7bb2f6b
2 parents c49e4ac + ff00f14
commit 7bb2f6b
Show file tree

Hide file tree

Showing 5 changed files with 18 additions and 0 deletions.
diff --git a/PullToRefresh_Framework.xcodeproj/project.pbxproj b/PullToRefresh_Framework.xcodeproj/project.pbxproj
@@ -10,6 +10,7 @@
 		172F078228A4F37B00AFD6A2 /* PullToRefresh_Framework.h in Headers */ = {isa = PBXBuildFile; fileRef = 172F078128A4F37B00AFD6A2 /* PullToRefresh_Framework.h */; settings = {ATTRIBUTES = (Public, ); }; };
 		172F078D28A4F44200AFD6A2 /* PullToRefreshView.swift in Sources */ = {isa = PBXBuildFile; fileRef = 172F078C28A4F44200AFD6A2 /* PullToRefreshView.swift */; };
 		17AC9E8C28AA4CC800DF8A2B /* Shakuro.PullToRefresh.podspec in Resources */ = {isa = PBXBuildFile; fileRef = 17AC9E8B28AA4CC800DF8A2B /* Shakuro.PullToRefresh.podspec */; };
+		6B473CAF28E6E0DE0040D82B /* .swiftlint.yml in Resources */ = {isa = PBXBuildFile; fileRef = 6B473CAE28E6E0DE0040D82B /* .swiftlint.yml */; };
 /* End PBXBuildFile section */
 
 /* Begin PBXFileReference section */
@@ -20,6 +21,7 @@
 		172F078A28A4F3E200AFD6A2 /* README.md */ = {isa = PBXFileReference; lastKnownFileType = net.daringfireball.markdown; path = README.md; sourceTree = "<group>"; };
 		172F078C28A4F44200AFD6A2 /* PullToRefreshView.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = PullToRefreshView.swift; sourceTree = "<group>"; };
 		17AC9E8B28AA4CC800DF8A2B /* Shakuro.PullToRefresh.podspec */ = {isa = PBXFileReference; explicitFileType = text.script.ruby; fileEncoding = 4; path = Shakuro.PullToRefresh.podspec; sourceTree = "<group>"; };
+		6B473CAE28E6E0DE0040D82B /* .swiftlint.yml */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = text.yaml; path = .swiftlint.yml; sourceTree = "<group>"; };
 /* End PBXFileReference section */
 
 /* Begin PBXFrameworksBuildPhase section */
@@ -39,6 +41,7 @@
 				172F078928A4F3E200AFD6A2 /* LICENSE.md */,
 				172F078A28A4F3E200AFD6A2 /* README.md */,
 				17AC9E8B28AA4CC800DF8A2B /* Shakuro.PullToRefresh.podspec */,
+				6B473CAE28E6E0DE0040D82B /* .swiftlint.yml */,
 				172F078028A4F37B00AFD6A2 /* PullToRefresh_Framework */,
 				172F078B28A4F44200AFD6A2 /* Source */,
 				172F077F28A4F37B00AFD6A2 /* Products */,
@@ -147,6 +150,7 @@
 			isa = PBXResourcesBuildPhase;
 			buildActionMask = 2147483647;
 			files = (
+				6B473CAF28E6E0DE0040D82B /* .swiftlint.yml in Resources */,
 				17AC9E8C28AA4CC800DF8A2B /* Shakuro.PullToRefresh.podspec in Resources */,
 			);
 			runOnlyForDeploymentPostprocessing = 0;

diff --git a/README.md b/README.md
@@ -10,6 +10,20 @@
 - [Usage](#usage)
 - [License](#license)
 
+A `PullToRefresh` is a custom control that you attach to any UIScrollView object, including table views and collection views. `PullToRefresh` has various configuration options.
+
+`PullToRefresh` example with default options:
+
+![](Resources/pull_to_refresh_example_1.gif)
+
+`PullToRefresh` example with animation logo:
+
+![](Resources/pull_to_refresh_example_2.gif)
+
+`PullToRefresh` example with sticky headers:
+
+![](Resources/pull_to_refresh_example_3.gif)
+
 ## Requirements
 
 - iOS 11.0+

diff --git a/Resources/pull_to_refresh_example_1.gif b/Resources/pull_to_refresh_example_1.gif
diff --git a/Resources/pull_to_refresh_example_2.gif b/Resources/pull_to_refresh_example_2.gif
diff --git a/Resources/pull_to_refresh_example_3.gif b/Resources/pull_to_refresh_example_3.gif