Skip to content

Commit bca43f2

Browse files
Update README.md
Fixed a few typos and made the README a little more concise.
1 parent 427a5fd commit bca43f2

File tree

1 file changed

+13
-31
lines changed

1 file changed

+13
-31
lines changed

README.md

Lines changed: 13 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,6 @@ HelpStack supports the following leading helpdesk solutions:
1717
- [HappyFox](https://www.happyfox.com/)
1818
- [Zendesk](https://www.zendesk.com/)
1919
- [Desk.com](http://www.desk.com/)
20-
2120
- Email - If you don't have a helpdesk solution, you can still configure HelpStack for users to raise requests via email.
2221

2322
You can choose any 1 of the 4 options mentioned above, to get started with HelpStack.
@@ -28,8 +27,8 @@ Check out [helpstack.io](http://www.helpstack.io) for more information.
2827
<img src="Images/hs_preview.png" alt="HelpStackthemes" title="screenshots">
2928
</p>
3029

31-
## Users
32-
If you use HelpStack, don't forget to send a Pull Request to this Wiki page: [HelpStack Android users](https://github.com/happyfoxinc/helpstack-android/wiki/HelpStack-Android-users)
30+
## HelpStack Android Users
31+
If you use HelpStack in your app, please let us know by adding yourself to this Wiki page: [HelpStack Android users](https://github.com/happyfoxinc/helpstack-android/wiki/HelpStack-Android-users)
3332

3433
## Installation
3534

@@ -91,31 +90,25 @@ Obtain the necessary credentials for the gear of your choice and create a suitab
9190
##### i. HappyFox:
9291

9392
public class HSApplication extends Application {
94-
9593
HSHelpStack helpStack;
9694
9795
@Override
9896
public void onCreate() {
9997
super.onCreate();
10098
101-
// Get the HSHelpStack instance
102-
helpStack = HSHelpStack.getInstance(this);
99+
helpStack = HSHelpStack.getInstance(this); // Get the HSHelpStack instance
103100
104-
// Crate the Gear object
105101
HSHappyfoxGear happyfoxGear = new HSHappyfoxGear(
106102
"<Account URL>",
107103
"<Your API Key>",
108104
"<Your Auth Code>",
109105
"<Category ID>",
110-
"<Priority ID>");
106+
"<Priority ID>"); // Create the Gear object
111107
112-
// [Optional] Set the Section Id of your Knowledge Base articles
113-
happyfoxGear.setSectionId("<Section id>");
108+
happyfoxGear.setSectionId("<Section id>"); // Optional. Set the Section Id of your Knowledge Base articles.
114109
115-
// Set the Gear
116-
helpStack.setGear(happyfoxGear);
110+
helpStack.setGear(happyfoxGear); // Set the Gear
117111
}
118-
119112
}
120113

121114
The API key and Auth code can be found in your HappyFox account under *Manage* > *Integrations*. You can generate an API key and Auth code by clicking on the API configure link.
@@ -130,29 +123,23 @@ Priority ID and Category ID cannot be nil. These are the ID's of the priority an
130123
##### ii. Zendesk:
131124

132125
public class HSApplication extends Application {
133-
134126
HSHelpStack helpStack;
135127
136128
@Override
137129
public void onCreate() {
138130
super.onCreate();
139131
140-
// Get the HSHelpStack instance
141-
helpStack = HSHelpStack.getInstance(this);
132+
helpStack = HSHelpStack.getInstance(this); // Get the HSHelpStack instance
142133
143-
// Crate the Gear object
144134
HSZendeskGear zendeskGear = new HSZendeskGear(
145135
"<Account URL>",
146136
"<Staff Email Address>",
147-
"<API Token");
137+
"<API Token"); // Create the Gear object
148138
149-
// [Optional] Set the Section Id of your Help Center articles
150-
zendeskGear.setSectionId("<Section id>");
139+
zendeskGear.setSectionId("<Section id>"); // Optional. Set the Section Id of your Help Center articles.
151140
152-
// Set the Gear
153-
helpStack.setGear(zendeskGear);
141+
helpStack.setGear(zendeskGear); // Set the Gear
154142
}
155-
156143
}
157144

158145
The token can be found in your Zendesk account under Settings > Channels > API. Setting the Section ID of your Help Center articles is optional. You can find the sections in your Zendesk account, as mentioned below:
@@ -163,27 +150,22 @@ The token can be found in your Zendesk account under Settings > Channels > API.
163150
##### iii. Desk:
164151

165152
public class HSApplication extends Application {
166-
167153
HSHelpStack helpStack;
168154
169155
@Override
170156
public void onCreate() {
171157
super.onCreate();
172158
173-
// Get the HSHelpStack instance
174-
helpStack = HSHelpStack.getInstance(this);
159+
helpStack = HSHelpStack.getInstance(this); // Get the HSHelpStack instance
175160
176-
// Crate the Gear object
177161
HSDeskGear deskGear = new HSDeskGear(
178162
"<Account URL>",
179163
"<To Help email address>",
180164
"<Staff email address>",
181-
"<Staff password");
165+
"<Staff password"); // Create the Gear object
182166
183-
// Set the Gear
184-
helpStack.setGear(deskGear);
167+
helpStack.setGear(deskGear); // Set the Gear
185168
}
186-
187169
}
188170

189171
##### iv. Email:

0 commit comments

Comments
 (0)