From 3c955759d2da46607c0237437901a969ae42f42c Mon Sep 17 00:00:00 2001
From: Philip Manavopoulos
Date: Thu, 29 Jan 2015 14:56:09 +0000
Subject: [PATCH 01/16] Fix typo
The code example said ```authoCode``` instead of ```authCode```
---
README.md | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/README.md b/README.md
index 2cb886f..dbaeb66 100644
--- a/README.md
+++ b/README.md
@@ -39,7 +39,7 @@ To integrate your existing HappyFox account into HelpStack, you just have to inc
HSHappyFoxGear *happyFoxGear = [[HSHappyFoxGear alloc]
initWithInstanceUrl : @"https://example.happyfox.com"
apiKey : @""
- authoCode : @""
+ authCode : @""
priorityID : @""
categoryID : @""];
happyFoxGear.hfSectionID = @""; // Optional
From 311127e9f09321d7298d9a97dd15103a4aa9172b Mon Sep 17 00:00:00 2001
From: moflo
Date: Thu, 5 Mar 2015 16:16:59 -0800
Subject: [PATCH 02/16] Update README.md
Adding clues for Swift usage.
---
README.md | 5 +++++
1 file changed, 5 insertions(+)
diff --git a/README.md b/README.md
index 2cb886f..f2e32c5 100644
--- a/README.md
+++ b/README.md
@@ -153,6 +153,11 @@ Once you have integrated your helpStack, use the **'showHelp'** API call to open
[[HSHelpStack instance] showHelp:self];
}
+Using Swift, show HelpStack using the following invocation:
+
+ let helpStack = HSHelpStack.instance() as HSHelpStack
+ helpStack.showHelp(self)
+
###Customizing Help Stack UI
From b33e72043d7fb540d6e4661c770828643cfd8d26 Mon Sep 17 00:00:00 2001
From: Anirudh S
Date: Tue, 17 Mar 2015 13:10:58 +0530
Subject: [PATCH 03/16] Make README concise and easier to read
---
README.md | 241 +++++++++++-------------------------------------------
1 file changed, 49 insertions(+), 192 deletions(-)
diff --git a/README.md b/README.md
index 3c38b2c..7f0b62b 100644
--- a/README.md
+++ b/README.md
@@ -3,7 +3,15 @@
-**HelpStack** provides you with a simple way of adding a great in-App support for your iOS App users. You can integrate any of your favorite HelpDesk solution at ease. It currently comes with three plugged in Help desk solutions - *Desk.com*, *Zendesk* and *HappyFox* along with customizable and simple UI to interact with the user.
+**HelpStack** provides you with a simple way of adding a great in-App support for your iOS App users. You can integrate any of your favorite HelpDesk solution at ease.
+
+HelpStack currently supports the following helpdesk solutions:
+- [HappyFox](https://www.happyfox.com/)
+- [Zendesk](https://www.zendesk.com/)
+- [Desk.com](http://www.desk.com/)
+- Email - If you don't have a helpdesk solution, you can still configure HelpStack for users to raise requests via email.
+
+The UI is also customizable so that it can go along with your app's theme.
@@ -12,16 +20,16 @@
## App Showcase
Have you made something awesome with HelpStack? Add yourself here: [App Showcase](https://github.com/happyfoxinc/helpstack/wiki/App-Showcase)
-## How to use Help Stack
-Integrating HelpStack into your app is an easy three-step process:
+## How to use HelpStack
+Integrating HelpStack into your app is an easy 3-step process:
1. Install HelpStack and its dependencies
2. Configure your desired Help desk solution
-3. Customize the HelpStack UI with a simple plist file
+3. Customize the UI of HelpStack with a simple plist file
-### Getting started with Help Stack
+### Installation
Use Cocoa Pods to install HelpStack and its dependencies. HelpStack dependencies include AFNetworking 2.0.
@@ -29,110 +37,26 @@ Use Cocoa Pods to install HelpStack and its dependencies. HelpStack dependencies
HelpStack requires Xcode 5.0 targeting iOS 7 and above.
-### Configuring Help Stack gears
-
-#### 1. HappyFox Gear
-
-To integrate your existing HappyFox account into HelpStack, you just have to include the following lines of code in your AppDelegate:
-
-
- HSHappyFoxGear *happyFoxGear = [[HSHappyFoxGear alloc]
- initWithInstanceUrl : @"https://example.happyfox.com"
- apiKey : @""
- authCode : @""
- priorityID : @""
- categoryID : @""];
- happyFoxGear.hfSectionID = @""; // Optional
-
- HSHelpStack *helpStack = [HSHelpStack instance];
- helpStack.gear = happyFoxGear;
-
-* Getting the API Key and Auth code
-
- Configuring HappyFox in HelpStack primarily requires the base URL, API Key and Auth code for authenticating the registered HappyFox user.
-
- You will find the API key and Auth code in the ‘*Integrations*’ page of your HappyFox account under ‘*Manage*’. You can generate an API key and Auth code by clicking on the API configure link.
-
-* Getting the Priority ID and Category ID
-
- HappyFox requires that the Priority ID and Category ID cannot be nil. This is the ID of the priority and the category with which tickets will be created when a customer reports an issue.
-
- For Priorities and its IDs:
- / /priorities/
-
- For categories and its IDs:
- / /categories/
-
- Use API Key and Auth code for authentication.
-
- *Example:*
-
- https://example.happyfox.com/api/1.1/json/priorities/
- https://example.happyfox.com/api/1.1/json/categories/
-
-* Getting the section ID (Optional)
- Section ID is to filter and show the Knowledge Based articles. If section ID is not provided, then all the KB articles in all the sections are fetched and showed. If you want HelpStack to fetch KB articles of a specific section, provide the appropriate section ID. The following URL command gives all the sections with their IDs.
+### Configuring HelpStack gears
- For sections and its IDs:
- / /kb/sections
-
- *Example:*
-
- https://example.happyfox.com/api/1.1/json/kb/sections/
-
- Use API key and Auth code for authentication.
-
-#### 2. ZenDesk gear
-
-To set up your existing ZenDesk account with HelpStack, just integrate the below lines of code in your AppDelegate.
-
- HSZenDeskGear *zenDeskGear = [[HSZenDeskGear alloc]
- initWithInstanceUrl : @"https://example.zendesk.com"
- staffEmailAddress : @"saff@example.com"
- apiToken : @""
- localArticlePath : @""];
-
- HSHelpStack *helpStack = [HSHelpStack instance];
- helpStack.gear = zenDeskGear;
-
-where, **staff email address** is the email address of staff on behalf of whom ticket will be created.
-
-* Getting the API Token
-
- The token can be found in your Zendesk account under *Settings* > *Channels* > *API*.
-
-* Providing FAQs
-
- Currently Zendesk does not provide an api to access FAQ/KB articles. It is soon to be [expected](https://support.zendesk.com/requests/531406). You can however provide your FAQ articles using a pList locally and you need to specify the path to the article when you configure Zendesk.
-
-
-#### 3. Desk gear
-
-To set up your Desk account with HelpStack, you need to integrate the following lines of code in your App delegate.
-
- HSDeskGear* deskGear = [[HSDeskGear alloc]
- initWithInstanceBaseUrl : @"https://example.desk.com/"
- toHelpEmail : @""
- staffLoginEmail : @""
- AndStaffLoginPassword : @""];
-
- HSHelpStack *helpStack = [HSHelpStack instance];
- helpStack.gear = deskGear;
-
-If you wish to provide your FAQs locally, you can provide it in the form of a pList file and specify the pList filename in the Desk Gear when you configure the same.
-
-#### 4. Email gear
+The general structure of a gear is as follows:
-If you do not use any of the help desk solutions, you can still use HelpStack to provide efficient customer support by configuring with just your email. You can configure email support in Helpstack by including the below lines of code in your App delegate.
+ * = [[ alloc]
+ parameter1 : value1
+ parameter2 : value2
+
+ parameterN : valueN ];
+
+ HSHelpStack *helpStack = [HSHelpStack instance];
+ helpStack.gear = ;
+
+HelpStack currently provides 4 different Gears. Follow the instructions below to configure the gear of your choice:
- HSGearEmail* emailGear = [[HSGearEmail alloc]
- initWithSupportEmailAddress : @"support@example.com"
- articlePath : @""];
-
- HSHelpStack *helpStack = [HSHelpStack instance];
- helpStack.gear = emailGear;
-
-You can provide your FAQs as a local pList file and provide the pList file name in place of *pList file name*.
+ - [HappyFox gear](https://github.com/happyfoxinc/helpstack/wiki/Configuring-gears-for-HelpStack#1-happyfox-gear)
+ - [Zendesk gear](https://github.com/happyfoxinc/helpstack/wiki/Configuring-gears-for-HelpStack#2-zendesk-gear)
+ - [Desk gear](https://github.com/happyfoxinc/helpstack/wiki/Configuring-gears-for-HelpStack#3-desk-gear)
+ - [Email gear](https://github.com/happyfoxinc/helpstack/wiki/Configuring-gears-for-HelpStack#4-email-gear)
+
### Shipping with Local Articles
@@ -158,8 +82,7 @@ Using Swift, show HelpStack using the following invocation:
let helpStack = HSHelpStack.instance() as HSHelpStack
helpStack.showHelp(self)
-
-###Customizing Help Stack UI
+###Customizing HelpStack UI
HelpStack comes with built in screens with a default theme. It also comes with a set of pre configured themes, which you can download from the link below:
@@ -188,111 +111,45 @@ Refer to [iosfonts.com](http://iosfonts.com) for the fonts supported by iOS.
Images which are included in your project must be specified with their filenames. e.g: **example.png**
-
-##### Customizing the Navigation Bar
-
-
-These properties control the look of the NavigationBar across all the helpStack screens.
+#### Customization
-* NavigationBarAttributes
+The following is a list of UI items you can customize, along with the instructions in the wiki:
+ - [Navigation Bar](https://github.com/happyfoxinc/helpstack/wiki/Customization-Instructions#i-customizing-the-navigation-bar)
+ - [Background](https://github.com/happyfoxinc/helpstack/wiki/Customization-Instructions#ii-customizing-the-background)
+ - [TableView](https://github.com/happyfoxinc/helpstack/wiki/Customization-Instructions#iii-customizing-the-tableview)
+ - [Chat screen](https://github.com/happyfoxinc/helpstack/wiki/Customization-Instructions#iv-customizing-the-chat-screen)
- **BackgroundColor** Navigation bar background color
-
- **BackgroundImage** Navigation bar background image, you either give an image or specify a color
-
- **TitleFont** Navigation bar title Font
-
- **TitleSize** Navigation bar title font size
-
- **TitleColor** Navigation bar title font color
-
- **ButtonTintColor** Navigation bar button tint color.
-##### Customizing the Background
-
-You can specify a background color or an image which is included in your resources directory to be set as the Background of all the helpStack screens.
-
-**BackgroundImageName** Specify the name of the image included in your project, which has to be applied as the background
-
-**BackgroundColor** Background color. You can either specify a color or include an image.
-
-
-##### Customizing the TableView
-
-These tableView properties are applied to the main list view which shows up the FAQs and Issues.
-
-* TableViewAttributes
-
- **TableBackgroundColor** Background color of the Table View
-
- **SeparatorColor** TableView separator Color
-
- **CellBackgroundColor** Background color of the cells
-
- **HeadingFont** Header Title font
-
- **HeadingSize** Header Title size
-
- **HeadingColor** Header Title color
-
- **HeadingBackgroundColor** Header background color
-
-The cell title is a label which can be customized by providing LabelAttributes :
-
-* LabelAttributes
- **BackgroundColor** Background color of the label. Ideally it would be better to give it as transparent.
-
- **LabelSize** Size of the label text
-
- **LabelFont** Font of the label text
-
- **LabelColor** Color of the label text
-
-##### Customizing the chat screen
-
-These chat screen properties allows customization of the Issue conversation view.
-
-* ChatBubbleAttributes :
-
- **TextSize** Size of the text that appears within the left and the right chat bubbles.
-
- **TextFont** Font of the text that appears within the left and the right chat bubbles.
-
- **MessageInfoLabelFont**, **MesssageInfoLabelSize**, **MessageInfoLabelColor** Font, Size and Color of the message information shown above and below the chat bubbles which includes the sender name and timestamp.
-
-The following attributes can be independantly customized for the right and the left chat bubbles :
-
- * LeftChatBubbleAttributes :
-
- **BackgroundColor** Background Color of the left chat bubble.
-
- **TextColor** Message Text color that appears within the left chat bubble.
-
- * RightChatBubbleAttributes :
-
- **BackgroundColor** Background Color of the right chat bubble.
-
- **TextColor** Message Text color that appears within the right chat bubble.
-
+## About
+For more information about HelpStack, visit [helpstack.io](http://www.helpstack.io).
+
+HelpStack is maintained by the folks at [HappyFox](http://www.happyfox.com/). Being an open source project, it also contains work from the HelpStack community.
+
+
+
+
+
+## Video
+[](https://www.youtube.com/watch?v=0UvNO-Qm0AUÂ)
## Contact
-Follow HelpStack on Twitter ([@HelpStackSDK](https://twitter.com/HelpStackSDK/))
+Reach out to us on Twitter at [@HelpStackSDK](https://twitter.com/HelpStackSDK).
## License
From 5a8828494cea499c448f8d11e4b838ef5422ec5b Mon Sep 17 00:00:00 2001
From: Anirudh S
Date: Tue, 17 Mar 2015 13:15:41 +0530
Subject: [PATCH 04/16] Add heading before customization screenshots
---
README.md | 5 +++--
1 file changed, 3 insertions(+), 2 deletions(-)
diff --git a/README.md b/README.md
index 7f0b62b..5b2d489 100644
--- a/README.md
+++ b/README.md
@@ -119,17 +119,18 @@ The following is a list of UI items you can customize, along with the instructio
- [TableView](https://github.com/happyfoxinc/helpstack/wiki/Customization-Instructions#iii-customizing-the-tableview)
- [Chat screen](https://github.com/happyfoxinc/helpstack/wiki/Customization-Instructions#iv-customizing-the-chat-screen)
+**Navigation Bar:**
-
+**Table View:**
-
+**Chat Screen:**
From e909fc7d776d2bbf3925b9f05bfeb133ef9b0a79 Mon Sep 17 00:00:00 2001
From: Anirudh S
Date: Tue, 17 Mar 2015 13:24:18 +0530
Subject: [PATCH 05/16] Made Customization Basics list concise
---
README.md | 12 +++---------
1 file changed, 3 insertions(+), 9 deletions(-)
diff --git a/README.md b/README.md
index 5b2d489..54fa1e8 100644
--- a/README.md
+++ b/README.md
@@ -98,18 +98,12 @@ You can start with one of these themes as your base. Download any of these pList
Certain pList properties must be provided in a pre-defined format as listed below:
-* Color
+- **Color** - Specify colors by providing its R,G,B,alpha value separated by commas. e.g: **255,255,255,1.0** is white.
- Specify colors by providing its R,G,B,alpha value separated by commas. e.g: **255,255,255,1.0** is white.
-
-* Font
-
- The font name and font size are to be provided as two separate properties in the pList file. Fonts are to be specified by its font family name and font style. e.g: **Helvetica-Bold** The specified font size will be taken as 'pts' by default.
+- **Font** - The font name and font size are to be provided as two separate properties in the pList file. Fonts are to be specified by its font family name and font style. e.g: **Helvetica-Bold** The specified font size will be taken as 'pts' by default.
Refer to [iosfonts.com](http://iosfonts.com) for the fonts supported by iOS.
-* Image
-
- Images which are included in your project must be specified with their filenames. e.g: **example.png**
+- **Image** - Images which are included in your project must be specified with their filenames. e.g: **example.png**
#### Customization
From 606812790e0b8286102783d9df6560354a24ef69 Mon Sep 17 00:00:00 2001
From: Anirudh S
Date: Tue, 17 Mar 2015 14:46:24 +0530
Subject: [PATCH 06/16] Add Gitter badge
---
README.md | 2 ++
1 file changed, 2 insertions(+)
diff --git a/README.md b/README.md
index 54fa1e8..201ead7 100644
--- a/README.md
+++ b/README.md
@@ -20,6 +20,8 @@ The UI is also customizable so that it can go along with your app's theme.
## App Showcase
Have you made something awesome with HelpStack? Add yourself here: [App Showcase](https://github.com/happyfoxinc/helpstack/wiki/App-Showcase)
+[](https://gitter.im/happyfoxinc/helpstack?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)
+
## How to use HelpStack
Integrating HelpStack into your app is an easy 3-step process:
From 0926cb26b38fd8c2b65ccf99c448933c64e8bb5f Mon Sep 17 00:00:00 2001
From: Anirudh S
Date: Tue, 26 May 2015 10:27:31 +0530
Subject: [PATCH 07/16] Added section: "How to progress with HelpStack"
---
README.md | 3 +++
1 file changed, 3 insertions(+)
diff --git a/README.md b/README.md
index 201ead7..9ca9871 100644
--- a/README.md
+++ b/README.md
@@ -17,6 +17,9 @@ The UI is also customizable so that it can go along with your app's theme.
+## How to progress with HelpStack
+Checkout this wiki page if you want a clear idea on how you can progress with HelpStack: [Wiki - How to progress with HelpStack](https://github.com/happyfoxinc/helpstack/wiki/How-to-Progress-with-HelpStack)
+
## App Showcase
Have you made something awesome with HelpStack? Add yourself here: [App Showcase](https://github.com/happyfoxinc/helpstack/wiki/App-Showcase)
From 944c6a63497dd3e62519cf4b0d68ffe7c081f0d0 Mon Sep 17 00:00:00 2001
From: ReadmeCritic
Date: Fri, 12 Feb 2016 08:37:45 -0800
Subject: [PATCH 08/16] Correct the spelling of CocoaPods in README
---
README.md | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/README.md b/README.md
index 9ca9871..36e0d42 100644
--- a/README.md
+++ b/README.md
@@ -36,7 +36,7 @@ Integrating HelpStack into your app is an easy 3-step process:
### Installation
-Use Cocoa Pods to install HelpStack and its dependencies. HelpStack dependencies include AFNetworking 2.0.
+Use CocoaPods to install HelpStack and its dependencies. HelpStack dependencies include AFNetworking 2.0.
pod 'HelpStack'
From 4344ebe181b35fe55419d5bbbbc0b8499bdae2f6 Mon Sep 17 00:00:00 2001
From: pavaniG
Date: Fri, 27 May 2016 09:06:14 +0530
Subject: [PATCH 09/16] - Scrolling issue fixed.
---
Classes/UI/HSMainListViewController.m | 6 ++++++
1 file changed, 6 insertions(+)
diff --git a/Classes/UI/HSMainListViewController.m b/Classes/UI/HSMainListViewController.m
index 623568e..8903a19 100644
--- a/Classes/UI/HSMainListViewController.m
+++ b/Classes/UI/HSMainListViewController.m
@@ -260,6 +260,12 @@ - (UITableViewCell *)tableView:(UITableView *)tableView cellForRowAtIndexPath:(N
}
+- (void)scrollViewDidScroll:(UIScrollView *)scrollView{
+ scrollView.scrollEnabled = true;
+}
+
+
+
#pragma mark - TableView Delegate methods
- (void)tableView:(UITableView *)tableView didSelectRowAtIndexPath:(NSIndexPath *)indexPath
From 90cadada5a05966d7c3249855e54002889f18552 Mon Sep 17 00:00:00 2001
From: anand
Date: Wed, 1 Jun 2016 17:59:42 +0530
Subject: [PATCH 10/16] v1.1.2 with minor scroll issue fixed
---
HelpStack.podspec | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/HelpStack.podspec b/HelpStack.podspec
index fb47446..337c1eb 100644
--- a/HelpStack.podspec
+++ b/HelpStack.podspec
@@ -1,7 +1,7 @@
Pod::Spec.new do |s|
s.name = "HelpStack"
- s.version = "1.1.1"
+ s.version = "1.1.2"
s.summary = "In-app customer support framework"
s.description = 'See helpstack.io for more details'
s.homepage = "https://github.com/happyfoxinc/helpstack"
From e1f1ab9a55da0be934352eef152f9acaf3b0de62 Mon Sep 17 00:00:00 2001
From: anand
Date: Wed, 1 Jun 2016 18:07:38 +0530
Subject: [PATCH 11/16] tag line updated in pod source
---
HelpStack.podspec | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/HelpStack.podspec b/HelpStack.podspec
index 337c1eb..a61930a 100644
--- a/HelpStack.podspec
+++ b/HelpStack.podspec
@@ -9,7 +9,7 @@ Pod::Spec.new do |s|
s.license = 'MIT'
s.author = { "HappyFox" => "ios@happyfox.com" }
s.platform = :ios, '7.0'
- s.source = { :git => "https://github.com/happyfoxinc/helpstack.git", :tag => "1.1.1", :submodules => true }
+ s.source = { :git => "https://github.com/happyfoxinc/helpstack.git", :tag => "1.1.2", :submodules => true }
s.resources = ['Resources/*.png','Resources/*.storyboard']
s.dependency 'AFNetworking', '~> 2.0'
s.frameworks = 'UIKit', 'CoreGraphics'
From 58c56cb378bbc6f25d55d8603d1537f9d9aa20ac Mon Sep 17 00:00:00 2001
From: Anand
Date: Thu, 25 Jan 2018 16:00:13 +0530
Subject: [PATCH 12/16] Fixes README images.
---
README.md | 10 +++++-----
1 file changed, 5 insertions(+), 5 deletions(-)
diff --git a/README.md b/README.md
index 36e0d42..dc9fcbd 100644
--- a/README.md
+++ b/README.md
@@ -1,5 +1,5 @@
-
+
@@ -14,7 +14,7 @@ HelpStack currently supports the following helpdesk solutions:
The UI is also customizable so that it can go along with your app's theme.
-
+
## How to progress with HelpStack
@@ -121,17 +121,17 @@ The following is a list of UI items you can customize, along with the instructio
**Navigation Bar:**