Skip to content

Commit d09508b

Browse files
committed
(docs): update README.md
update category page support documentation
1 parent b1e1afb commit d09508b

File tree

1 file changed

+9
-9
lines changed

1 file changed

+9
-9
lines changed

README.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -2,16 +2,16 @@ Unbxd JavaScript Search library
22
===============================
33
[![Build Status](https://travis-ci.org/unbxd/js-sdk.svg?branch=master)](https://travis-ci.org/unbxd/js-sdk.svg?branch=master)
44

5-
unbxdSearch.js library can be used to integrated UNBXD search or browse on client side. It supports History API, so users can share the URI.
5+
unbxdSearch.js library can be used to integrated UNBXD search and category page on client side. It supports History API, so users can share the URI.
66

77
Note : _*This library makes use of jQuery selectors and Handlebars templates.*_
88

99
_*Please find an example of implementation in demo folder.*_
1010

11-
##Usage
11+
## Usage
1212
Just include [unbxdSearch.js](//d21gpk1vhmjuf5.cloudfront.net/unbxdSearch.js) in HTML and include the configuration.
1313

14-
##configuration
14+
## configuration
1515
Consider a normal search page with basic layout as shown in the figure below and respective configuration below the image.
1616

1717
![Basic search layout](https://raw.githubusercontent.com/unbxd/js-sdk/master/images/search_layout.png "Basic search layout")
@@ -137,11 +137,11 @@ Consider a normal search page with basic layout as shown in the figure below and
137137

138138
- **siteName** : This value can be found in UNBXD dashboard. It is unique for every search site created in the dashboard.
139139
- **APIKey** : This is a unique for every user account. It can also be found in dashboard.
140-
- **type** : It has to be either _*search*_ or _*browse*_.
141-
- **getCategoryId** : This option has to be a function which return the category_id in case of *browse*. Please ignore incase of *search*.
142-
- **inputSelector** : The jQuery selector for search input. Please make sure that the form of this input has no action and method is GET. Please ignore incase of *browse*.
143-
- **searchButtonSelector** : The jQuery selector for search submit button. Please ignore incase of *browse*.
144-
- **spellCheck** : The jQuery selector for DOM element to display spell suggestion. Please ignore incase of *browse*.
140+
- **type** : It has to be either _*search*_, _*browse*_ or _*category*_.
141+
- **getCategoryId** : This option has to be a function which return the category_id in case of *browse* and *category*. Please ignore incase of *search*.
142+
- **inputSelector** : The jQuery selector for search input. Please make sure that the form of this input has no action and method is GET. Please ignore incase of *browse* and *category*.
143+
- **searchButtonSelector** : The jQuery selector for search submit button. Please ignore incase of *browse* and *category*.
144+
- **spellCheck** : The jQuery selector for DOM element to display spell suggestion. Please ignore incase of *browse* and *category*.
145145
- **spellCheckTemp** : Handlebars template for generating the spell suggestion template.
146146
```javascript
147147
...
@@ -154,7 +154,7 @@ Consider a normal search page with basic layout as shown in the figure below and
154154
suggestion : "something else"
155155
}
156156
```
157-
- **searchQueryDisplay** : The jQuery selector of DOM element to display the query (which use has searched for) and total number of results from search. Please ignore incase of *browse*.
157+
- **searchQueryDisplay** : The jQuery selector of DOM element to display the query (which use has searched for) and total number of results from search. Please ignore incase of *browse* and *category*.
158158
- **searchQueryDisplayTemp** : Handlebars template for displaying the search query and total number of results. Please ignore incase of *browse*.
159159
```javascript
160160
...

0 commit comments

Comments
 (0)