Skip to content

Commit b4495a4

Browse files
goodrootJasonStoltz
authored andcommitted
Use Fancy README (#52)
Changes to a fancier style of README.
1 parent 897528c commit b4495a4

File tree

2 files changed

+72
-37
lines changed

2 files changed

+72
-37
lines changed

README.md

Lines changed: 72 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,24 @@
1-
# Javascript client for the Swiftype App Search Api
1+
<p align="center"><img src="https://github.com/swiftype/swiftype-app-search-javascript/blob/master/logo-app-search.png?raw=true" alt="Elastic App Search Logo"></p>
22

3-
[![CircleCI](https://circleci.com/gh/swiftype/swiftype-app-search-javascript.svg?style=svg)](https://circleci.com/gh/swiftype/swiftype-app-search-javascript)
3+
<p align="center"><a href="https://circleci.com/gh/swiftype/swiftype-app-search-javascript"><img src="https://circleci.com/gh/swiftype/swiftype-app-search-javascript.svg?style=svg" alt="CircleCI buidl"></a>
4+
<a href="https://github.com/swiftype/swiftype-app-search-javascript/releases"><img src="https://img.shields.io/github/release/swiftype/swiftype-app-search-javascript/all.svg?style=flat-square" alt="GitHub release" /></a></p>
45

5-
## Browser support
6+
> A first-party JavaScript client for building excellent, relevant search experiences with [Elastic App Search](https://www.elastic.co/cloud/app-search-service).
67
7-
The client is compatible with all modern browsers.
8+
## Contents
89

9-
Note that this library depends on the Fetch API: https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API.
10+
- [Getting started](#getting-started-)
11+
- [Browser support](#browser-support)
12+
- [Usage](#usage)
13+
- [Running tests](#running-tests)
14+
- [Development](#development)
15+
- [FAQ](#faq-)
16+
- [Contribute](#contribute-)
17+
- [License](#license-)
1018

11-
This is not supported by Internet Explorer. If you need backwards compatibility
12-
for Internet Explorer, you'll need to polyfill the Fetch API with something
13-
like https://github.com/github/fetch.
19+
---
1420

15-
## Getting Started
21+
## Getting started 🐣
1622

1723
### Install from a CDN
1824

@@ -46,6 +52,16 @@ var SwiftypeAppSearch = require("swiftype-app-search-javascript");
4652
import * as SwiftypeAppSearch from "swiftype-app-search-javascript";
4753
```
4854

55+
## Browser support
56+
57+
The client is compatible with all modern browsers.
58+
59+
Note that this library depends on the [Fetch API](https://developer.mozilla.org/en-US/docs/Web/API/Fetch_AP).
60+
61+
This is not supported by Internet Explorer. If you need backwards compatibility
62+
for Internet Explorer, you'll need to polyfill the Fetch API with something
63+
like https://github.com/github/fetch.
64+
4965
## Usage
5066

5167
### Setup: Configuring the client and authentication
@@ -216,32 +232,55 @@ document.addEventListener("click", function(e) {
216232
</a>
217233
```
218234

235+
## Running tests
236+
237+
The specs in this project use [node-replay](https://github.com/assaf/node-replay) to capture responses.
238+
239+
The responses are then checked against Jest snapshots.
240+
241+
To capture new responses and update snapshots, run:
242+
243+
```
244+
nvm use
245+
REPLAY=record yarn test -u
246+
```
247+
248+
To run tests:
249+
250+
```
251+
nvm use
252+
yarn test
253+
```
254+
219255
## Development
220256

221257
### Node
222258

223-
We depend upon the version of node defined in [.nvmrc](.nvmrc).
259+
You will probably want to install a node version manager, like nvm.
224260

225-
You will probably want to install a node version manager. nvm is recommended.
261+
We depend upon the version of node defined in [.nvmrc](.nvmrc).
226262

227263
To install and use the correct node version with nvm:
228264

229265
```
230266
nvm install
231267
```
232268

233-
### Running Tests
269+
### Dev Server
270+
271+
Install dependencies:
234272

235273
```
236-
nvm use
237-
yarn test
274+
yarn
238275
```
239276

240-
### Build
277+
Run dev server:
278+
279+
```
280+
yarn dev
281+
```
241282

242-
This is run on `prepare` in [package.json](package.json). That means
243-
this will be run when running `yarn` to install dependencies, and
244-
also before publishing to npm.
283+
### Build
245284

246285
```
247286
nvm use
@@ -255,33 +294,29 @@ nvm use
255294
yarn publish
256295
```
257296

258-
### Adding and updating tests
297+
## FAQ 🔮
259298

260-
The specs in this project use [node-replay](https://github.com/assaf/node-replay) to capture responses.
299+
### Where do I report issues with the client?
261300

262-
The responses are then checked against Jest snapshots.
301+
If something is not working as expected, please open an [issue](https://github.com/swiftype/swiftype-app-search-javascript/issues/new).
263302

264-
To capture new responses and update snapshots, run tests with the following commands:
303+
### Where can I learn more about App Search?
265304

266-
```
267-
nvm use // Be sure to use the correct version of node
268-
REPLAY=record yarn test -u
269-
```
305+
Your best bet is to read the [documentation](https://swiftype.com/documentation/app-search).
270306

271-
## Contributions
307+
### Where else can I go to get help?
272308

273-
To contribute code, please fork the repository and submit a pull request.
309+
You can checkout the [Elastic App Search community discuss forums](https://discuss.elastic.co/c/app-search).
274310

275-
## Development
311+
## Contribute 🚀
276312

277-
Install dependencies
313+
We welcome contributors to the project. Before you begin, a couple notes...
278314

279-
```
280-
yarn
281-
```
315+
- Prior to opening a pull request, please create an issue to [discuss the scope of your proposal](https://github.com/swiftype/swiftype-app-search-javascript/issues).
316+
- Please write simple code and concise documentation, when appropriate.
282317

283-
Run dev server
318+
## License 📗
284319

285-
```
286-
yarn dev
287-
```
320+
[MIT](https://github.com/swiftype/swiftype-app-search-javascript/blob/master/LICENSE) © [Elastic](https://github.com/elastic)
321+
322+
Thank you to all the [contributors](https://github.com/swiftype/swiftype-app-search-javascript/graphs/contributors)!

logo-app-search.png

27.3 KB
Loading

0 commit comments

Comments
 (0)