Skip to content
This repository was archived by the owner on Jun 25, 2025. It is now read-only.

Commit 39987cd

Browse files
authored
Merge pull request #3 from apisearch-io/feature/updated-dependencies
Updated dependencies
2 parents 9af8a98 + 7342394 commit 39987cd

File tree

5 files changed

+4201
-1731
lines changed

5 files changed

+4201
-1731
lines changed

.circleci/config.yml

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
version: 2
2+
jobs:
3+
build:
4+
docker:
5+
- image: circleci/node:7.10.0
6+
steps:
7+
- checkout
8+
- run:
9+
name: Install dependencies
10+
command: |
11+
npm install
12+
- run:
13+
name: Run test scenarios
14+
command: |
15+
npm run test

.travis.yml

Lines changed: 0 additions & 4 deletions
This file was deleted.

README.md

Lines changed: 19 additions & 48 deletions
Original file line numberDiff line numberDiff line change
@@ -1,55 +1,26 @@
1-
Apisearch Javascript client
2-
===========================
1+
# Apisearch - Server
32

4-
This repository is part of the ApiSearch project.
3+
This library is part of the Apisearch project.
54

6-
This library aims to provide to any Javascript developer nicely interfaces to
7-
manage search-only processes related to Apisearch, using
8-
basic ES6 modules.
5+
[![CircleCI](https://circleci.com/gh/apisearch-io/javascript-client.svg?style=svg)](https://circleci.com/gh/apisearch-io/javascript-client)
6+
[![Join the chat](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/apisearch_io/general)
97

10-
Is UMD compatible if you are using module loaders, otherwise apisearch will be
11-
in the `window` object as `apisearch`.
12-
8+
Apisearch is an open source search engine fully based on open source third party
9+
technologies. The project provides an *in cresciendo* set of language
10+
integration libraries for her users, as well as some third party projects
11+
integration bundles, plugins, or javascript widgets.
1312

14-
## Install
13+
Some first steps for you!
1514

16-
```shell
17-
npm install apisearch --save
18-
# or
19-
yarn add apisearch
20-
```
15+
- [Download and install Apisearch](http://docs.apisearch.io/#download-and-install-apisearch)
16+
- [Create your first application](http://docs.apisearch.io/#create-your-first-application)
17+
- [Add some data](http://docs.apisearch.io/#add-some-data)
18+
- [Create your first search bar](http://docs.apisearch.io/#create-my-first-search-bar)
2119

22-
You can either download the library and use a relative path to your assets folder,
23-
or use a CDN like jsDelivr.
20+
Take a tour using these links.
2421

25-
```html
26-
<script src="https://cdn.jsdelivr.net/npm/apisearch/dist/apisearch.min.js"></script>
27-
```
28-
29-
30-
## Getting started
31-
32-
Let's see a simple example on how to make queries: Instance the apisearch client,
33-
build a query, and search! Super easy right?
34-
```javascript
35-
const api = apisearch({
36-
appId: 'music',
37-
index: 'default',
38-
token: '1cc7a3e0-bda5-11e7-abc4-cec278b6b50a'
39-
});
40-
41-
const query = api.query.create('Your search query');
42-
43-
api.search(query, function(result, error) {
44-
if (error) {
45-
console.log(error);
46-
return;
47-
}
48-
49-
console.log(result);
50-
});
51-
```
52-
53-
## More resources:
54-
- [Github examples](https://github.com/alexhoma/javascript-search-client/blob/master/examples)
55-
- [Documentation](http://docs.apisearch.io)
22+
- [Documentation](http://docs.apisearch.io)
23+
- [View a demo](http://apisearch.io)
24+
- [Talk with us](https://apisearch.slack.com)
25+
- [Twitter](https://twitter.com/apisearch_io)
26+
- [Youtube Channel]()

0 commit comments

Comments
 (0)