You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+8-3
Original file line number
Diff line number
Diff line change
@@ -1,4 +1,5 @@
1
-
# WebExtension: SearchAutocomplete
1
+
WebExtension: SearchAutocomplete
2
+
================================
2
3
3
4
This WebExtension aims to give you quick, keyword based autocomplete for your search engines. Making your address bar an effective tool again ;-). Should be a good replacement for Omnibar add-on (that worked until FF 56).
4
5
@@ -18,7 +19,7 @@ Custom search engines
18
19
19
20
### Wikipedia and similar ###
20
21
21
-
Currently I support any search engine that is roughly similar to Wikipedia API. Wikipedia is using `application/x-suggestions+json` format (MIME).
22
+
Currently I support any search engine that is roughly similar to Wikipedia API. Wikipedia uses the [OpenSearch Suggestions standard](http://www.opensearch.org/Specifications/OpenSearch/Extensions/Suggestions/1.0#Response_Content).
22
23
23
24
For this format the server returns something like this:
24
25
```
@@ -50,10 +51,14 @@ This extension was initially created with [Chrome Extension Generator (Yeoman)](
50
51
51
52
### Prepare for building ###
52
53
53
-
1. You will need [Node.js](https://nodejs.org/en/) for building. I used 8.9, but not sure if any specific version is required. It does need to support ES2015 modules.
54
+
1. You will need [Node.js](https://nodejs.org/en/) for building the extension and downloading modules. I used Node.js 8.9, but version 4.0 (or higher) should be fine(*).
54
55
2. You need to install modules (`npm install`).
55
56
3. (Optional) Install [Visual Studio Code](https://code.visualstudio.com/). Not required, but makes running tasks a bit easier.
56
57
58
+
(*) Version 4.0 is required e.g. by Mocha and it's also the first Node.js version with ES6 / ES2015 support.
59
+
60
+
If you need to use older Node.js for other projects then install [nvm](https://github.com/creationix/nvm) (Linux and Mac) or [nvm-windows](https://github.com/coreybutler/nvm-windows). Note! Do *not* install `nvm-windows` in `C:\Program Files`. In fact you should *not* use any directories with a space character for `nvm-windows` installation.
61
+
57
62
### Important tasks ###
58
63
59
64
All important tasks are defined in `.vscode/tasks.json` and can be run in VS Code (menu Tasks → Run Task...).
0 commit comments