Skip to content

Commit

Permalink
Editable limit parameter. Updated links in README.md.
Browse files Browse the repository at this point in the history
  • Loading branch information
NistorCristian committed Jan 28, 2019
1 parent e820cf8 commit 59f6f72
Show file tree
Hide file tree
Showing 7 changed files with 16 additions and 17 deletions.
14 changes: 8 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
[![Dependency Status](https://david-dm.org/HauntedThemes/ghost-search/status.svg)](https://david-dm.org/HauntedThemes/ghost-search)
[![devDependency Status](https://david-dm.org/HauntedThemes/ghost-search/dev-status.svg)](https://david-dm.org/HauntedThemes/ghost-search?type=dev)
[![Min Ghost Version](https://img.shields.io/badge/Min%20Ghost%20v.-%3E%3D%202.10.0-blue.svg)](https://github.com/TryGhost/Ghost)
[![npm version](https://badge.fury.io/js/ghost-search.svg)](https://www.npmjs.com/package/ghost-search)

# ghost-search
Expand Down Expand Up @@ -60,7 +59,7 @@ Get the admin domain. This will be different in some cases. [More details](https
## Use ghost-search from CDN

```html
<script src="https://cdn.jsdelivr.net/npm/ghost-search@1.0.0/dist/ghost-search.min.js"></script>
<script src="https://cdn.jsdelivr.net/npm/ghost-search@1.0.1/dist/ghost-search.min.js"></script>
```

## npm
Expand Down Expand Up @@ -324,10 +323,10 @@ Default value:

### api

The api parameter is an object that supports most of the [resources](https://api.ghost.org/docs/post) and [parameters](https://api.ghost.org/docs/limit) by [Ghost API](https://api.ghost.org).
The api parameter is an object that supports most of the [resources](https://docs.ghost.org/api/content/#resources) and [parameters](https://docs.ghost.org/api/content/#parameters) by [Content API](https://docs.ghost.org/api/content/).

Resources: [posts](https://api.ghost.org/docs/post), [tags](https://api.ghost.org/docs/tag), [users](https://api.ghost.org/docs/user) \
Parameters: [fields](https://api.ghost.org/docs/fields), [filter](https://api.ghost.org/docs/filter), [include](https://api.ghost.org/docs/include), [order](https://api.ghost.org/docs/order), [formats](https://api.ghost.org/docs/formats), [limit](https://api.ghost.org/docs/limit)
Resources: [posts](https://docs.ghost.org/api/content/#posts), [tags](https://docs.ghost.org/api/content/#tags), [authors](https://docs.ghost.org/api/content/#authors) \
Parameters: [fields](https://docs.ghost.org/api/content/#fields), [filter](https://docs.ghost.org/api/content/#filter), [include](https://docs.ghost.org/api/content/#include), [order](https://docs.ghost.org/api/content/#order), [formats](https://docs.ghost.org/api/content/#formats), [limit](https://docs.ghost.org/api/content/#limit)

Examples:

Expand Down Expand Up @@ -438,6 +437,9 @@ If you have a lot of posts and set `trigger` to `load` you might get a DDOS effe

## Changelog

### 1.0.1 - 28 Jan 2019
* Editable limit parameter. [5](https://github.com/HauntedThemes/ghost-search/issues/5)

### 1.0.0 - 21 Jan 2019
* Public API (deprecated) will not work anymore. The library is accessing Content API.

Expand Down
5 changes: 2 additions & 3 deletions dist/ghost-search.js

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion dist/ghost-search.js.map

Large diffs are not rendered by default.

6 changes: 3 additions & 3 deletions dist/ghost-search.min.js

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion dist/ghost-search.min.js.map

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "ghost-search",
"version": "1.0.0",
"version": "1.0.1",
"description": "A simple but powerful search library for Ghost Blogging Platform.",
"main": "dist/ghost-search.js",
"scripts": {
Expand Down
2 changes: 0 additions & 2 deletions src/ghost-search.js
Original file line number Diff line number Diff line change
Expand Up @@ -89,8 +89,6 @@ class GhostSearch {
}
}

browse.limit = 'all';

ghostAPI[this.api.resource]
.browse(browse)
.then((data) => {
Expand Down

0 comments on commit 59f6f72

Please sign in to comment.