Skip to content

Commit 10cea1b

Browse files
perteadrianperteadrian
committed
updated readme
with usage description
1 parent 35ce62a commit 10cea1b

File tree

6 files changed

+21
-33
lines changed

6 files changed

+21
-33
lines changed

‎.DS_Store‎

0 Bytes
Binary file not shown.

‎CircleBar.podspec‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,8 @@
88

99
Pod::Spec.new do |s|
1010
s.name = 'CircleBar'
11-
s.version = '0.8.0'
12-
s.summary = 'Really cool UITabBar'
11+
s.version = '0.8.1'
12+
s.summary = 'A fun, easy-to-use tab bar navigation controller for iOS.'
1313

1414
# This description is used to generate tags and improve search results.
1515
# * Think: What does it do? Why did you write it? What is the focus?
@@ -22,7 +22,7 @@ TODO: Add long description of the pod here.
2222
DESC
2323

2424
s.homepage = 'https://github.com/softhausHQ/CircleBar'
25-
# s.screenshots = 'www.example.com/screenshots_1', 'www.example.com/screenshots_2'
25+
s.screenshots = 'https://user-images.githubusercontent.com/7403338/53284076-884de700-3757-11e9-9185-33a67e7b3ba0.gif'
2626
s.license = { :type => 'MIT', :file => 'LICENSE' }
2727
s.author = { 'softhaus' => '[email protected]' }
2828
s.source = { :git => 'https://github.com/softhausHQ/CircleBar.git', :tag => s.version.to_s }

‎Example/CircleBar.xcodeproj/project.pbxproj‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@
4242
607FACEB1AFB9204008FA782 /* Tests.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = Tests.swift; sourceTree = "<group>"; };
4343
64804F4457C7324CACEEAC0A /* Pods-CircleBar_Tests.debug.xcconfig */ = {isa = PBXFileReference; includeInIndex = 1; lastKnownFileType = text.xcconfig; name = "Pods-CircleBar_Tests.debug.xcconfig"; path = "Target Support Files/Pods-CircleBar_Tests/Pods-CircleBar_Tests.debug.xcconfig"; sourceTree = "<group>"; };
4444
82704DDE2220DE2D008AF50C /* Main.storyboard */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = file.storyboard; path = Main.storyboard; sourceTree = "<group>"; };
45-
8EC87CAD00F3EEC2788B6796 /* CircleBar.podspec */ = {isa = PBXFileReference; includeInIndex = 1; lastKnownFileType = text; name = CircleBar.podspec; path = ../CircleBar.podspec; sourceTree = "<group>"; xcLanguageSpecificationIdentifier = xcode.lang.ruby; };
45+
8EC87CAD00F3EEC2788B6796 /* CircleBar.podspec */ = {isa = PBXFileReference; includeInIndex = 1; lastKnownFileType = text; name = CircleBar.podspec; path = ../CircleBar.podspec; sourceTree = "<group>"; wrapsLines = 0; xcLanguageSpecificationIdentifier = xcode.lang.ruby; };
4646
8F7AA60E30091B02E2B8F377 /* Pods_CircleBar_Tests.framework */ = {isa = PBXFileReference; explicitFileType = wrapper.framework; includeInIndex = 0; path = Pods_CircleBar_Tests.framework; sourceTree = BUILT_PRODUCTS_DIR; };
4747
A9EAC8BF1B3E81D45124A77A /* LICENSE */ = {isa = PBXFileReference; includeInIndex = 1; lastKnownFileType = text; name = LICENSE; path = ../LICENSE; sourceTree = "<group>"; };
4848
C98010CD4B98A08627A2B7B6 /* Pods-CircleBar_Tests.release.xcconfig */ = {isa = PBXFileReference; includeInIndex = 1; lastKnownFileType = text.xcconfig; name = "Pods-CircleBar_Tests.release.xcconfig"; path = "Target Support Files/Pods-CircleBar_Tests/Pods-CircleBar_Tests.release.xcconfig"; sourceTree = "<group>"; };

‎Example/CircleBar.xcworkspace/xcuserdata/perteadi.xcuserdatad/UserInterfaceState.xcuserstate‎

767 Bytes
Binary file not shown.

‎Example/CircleBar/Main.storyboard‎

Lines changed: 8 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -9,26 +9,7 @@
99
<capability name="documents saved in the Xcode 8 format" minToolsVersion="8.0"/>
1010
</dependencies>
1111
<scenes>
12-
<!--View Controller-->
13-
<scene sceneID="tne-QT-ifu">
14-
<objects>
15-
<viewController id="BYZ-38-t0r" customClass="ViewController" customModule="CircleBar_Example" customModuleProvider="target" sceneMemberID="viewController">
16-
<view key="view" contentMode="scaleToFill" id="8bC-Xf-vdC">
17-
<rect key="frame" x="0.0" y="0.0" width="375" height="667"/>
18-
<autoresizingMask key="autoresizingMask" widthSizable="YES" heightSizable="YES"/>
19-
<color key="backgroundColor" red="0.0" green="0.47843137250000001" blue="1" alpha="1" colorSpace="custom" customColorSpace="sRGB"/>
20-
<viewLayoutGuide key="safeArea" id="6Tk-OE-BBY"/>
21-
</view>
22-
<tabBarItem key="tabBarItem" image="about" id="54M-Nt-1TM">
23-
<color key="badgeColor" red="0.3411764706" green="0.72549019609999998" blue="0.60784313729999995" alpha="1" colorSpace="custom" customColorSpace="sRGB"/>
24-
<offsetWrapper key="titlePositionAdjustment" horizontal="0.0" vertical="-6"/>
25-
</tabBarItem>
26-
</viewController>
27-
<placeholder placeholderIdentifier="IBFirstResponder" id="dkx-z0-nzr" sceneMemberID="firstResponder"/>
28-
</objects>
29-
<point key="canvasLocation" x="1076" y="133.5832083958021"/>
30-
</scene>
31-
<!--asd-->
12+
<!--View 1-->
3213
<scene sceneID="HrQ-bk-zak">
3314
<objects>
3415
<viewController id="PN1-mI-Mpj" customClass="ViewController" customModule="CircleBar_Example" customModuleProvider="target" sceneMemberID="viewController">
@@ -38,7 +19,7 @@
3819
<color key="backgroundColor" red="0.45098039220000002" green="0.34509803919999998" blue="0.96078431369999995" alpha="1" colorSpace="custom" customColorSpace="sRGB"/>
3920
<viewLayoutGuide key="safeArea" id="Ni4-BZ-rv1"/>
4021
</view>
41-
<tabBarItem key="tabBarItem" title="asd" image="apple" id="6WL-HR-obU">
22+
<tabBarItem key="tabBarItem" title="View 1" image="apple" id="6WL-HR-obU">
4223
<color key="badgeColor" red="0.90588235289999997" green="0.42745098040000001" blue="0.17254901959999999" alpha="1" colorSpace="calibratedRGB"/>
4324
</tabBarItem>
4425
</viewController>
@@ -66,7 +47,7 @@
6647
</objects>
6748
<point key="canvasLocation" x="2274" y="-714"/>
6849
</scene>
69-
<!--asd-->
50+
<!--View 2-->
7051
<scene sceneID="Fkb-PL-eXY">
7152
<objects>
7253
<viewController id="MM3-fs-zMs" customClass="ViewController" customModule="CircleBar_Example" customModuleProvider="target" sceneMemberID="viewController">
@@ -76,15 +57,15 @@
7657
<color key="backgroundColor" name="systemPinkColor" catalog="System" colorSpace="catalog"/>
7758
<viewLayoutGuide key="safeArea" id="tU0-ki-joq"/>
7859
</view>
79-
<tabBarItem key="tabBarItem" title="asd" image="approval" id="0S5-D7-S5D">
60+
<tabBarItem key="tabBarItem" title="View 2" image="approval" id="0S5-D7-S5D">
8061
<color key="badgeColor" red="0.38823529410000002" green="0.26274509800000001" blue="0.95294117649999999" alpha="1" colorSpace="calibratedRGB"/>
8162
</tabBarItem>
8263
</viewController>
8364
<placeholder placeholderIdentifier="IBFirstResponder" id="jcN-dd-acY" sceneMemberID="firstResponder"/>
8465
</objects>
8566
<point key="canvasLocation" x="2583" y="134"/>
8667
</scene>
87-
<!--asd-->
68+
<!--View 3-->
8869
<scene sceneID="atI-RU-25k">
8970
<objects>
9071
<viewController id="qmx-bn-hT0" customClass="ViewController" customModule="CircleBar_Example" customModuleProvider="target" sceneMemberID="viewController">
@@ -94,15 +75,15 @@
9475
<color key="backgroundColor" red="0.90588235289999997" green="0.42745098040000001" blue="0.17254901959999999" alpha="1" colorSpace="custom" customColorSpace="sRGB"/>
9576
<viewLayoutGuide key="safeArea" id="0gA-K9-yFr"/>
9677
</view>
97-
<tabBarItem key="tabBarItem" title="asd" image="bell" id="yRC-Jh-mdH">
78+
<tabBarItem key="tabBarItem" title="View 3" image="bell" id="yRC-Jh-mdH">
9879
<color key="badgeColor" name="systemPinkColor" catalog="System" colorSpace="catalog"/>
9980
</tabBarItem>
10081
</viewController>
10182
<placeholder placeholderIdentifier="IBFirstResponder" id="6Uo-um-9fM" sceneMemberID="firstResponder"/>
10283
</objects>
10384
<point key="canvasLocation" x="3273" y="134"/>
10485
</scene>
105-
<!--asd-->
86+
<!--View 4-->
10687
<scene sceneID="XV1-At-ypd">
10788
<objects>
10889
<viewController id="K93-Zf-XJ1" customClass="ViewController" customModule="CircleBar_Example" customModuleProvider="target" sceneMemberID="viewController">
@@ -112,7 +93,7 @@
11293
<color key="backgroundColor" red="0.3411764706" green="0.72549019609999998" blue="0.60784313729999995" alpha="1" colorSpace="custom" customColorSpace="sRGB"/>
11394
<viewLayoutGuide key="safeArea" id="XhL-vf-R9Z"/>
11495
</view>
115-
<tabBarItem key="tabBarItem" title="asd" image="approval" id="XKK-fW-YWm">
96+
<tabBarItem key="tabBarItem" title="View 4" image="about" id="XKK-fW-YWm">
11697
<color key="badgeColor" name="systemPinkColor" catalog="System" colorSpace="catalog"/>
11798
</tabBarItem>
11899
</viewController>

‎README.md‎

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -50,14 +50,21 @@ pod 'CircleBar'
5050

5151

5252
# Roadmap
53-
- [ ] Write the Usage section
53+
- [x] Write the Usage section
5454
- [ ] Improve landscape support
5555
- [ ] Improve transitions
5656
- [ ] Release v1.0
5757
- [ ] iPad support
5858

5959
# Usage
60-
<br>
60+
1. Create a new `UITabBarController` in your storyboard or nib.
61+
62+
2. Set the class of the `UITabBarController` to `SHTabBarController` in your Storyboard or nib.
63+
64+
3. Set the class of the `UITabBar` of `SHTabBarController` to `SHTabBar` in your Storyboard or nib.
65+
66+
4. Add a custom image icon and title for `UITabBarItem` of each child `UIViewContrroller`.
67+
6168

6269

6370
# Example

0 commit comments

Comments
 (0)