Skip to content

Commit 1cb67b3

Browse files
committed
corrections and clarifications
1 parent 14f7384 commit 1cb67b3

File tree

2 files changed

+9
-4
lines changed

2 files changed

+9
-4
lines changed

README.md

+8-3
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
1-
# WebExtension: SearchAutocomplete
1+
WebExtension: SearchAutocomplete
2+
================================
23

34
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).
45

@@ -18,7 +19,7 @@ Custom search engines
1819

1920
### Wikipedia and similar ###
2021

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).
2223

2324
For this format the server returns something like this:
2425
```
@@ -50,10 +51,14 @@ This extension was initially created with [Chrome Extension Generator (Yeoman)](
5051

5152
### Prepare for building ###
5253

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(*).
5455
2. You need to install modules (`npm install`).
5556
3. (Optional) Install [Visual Studio Code](https://code.visualstudio.com/). Not required, but makes running tasks a bit easier.
5657

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+
5762
### Important tasks ###
5863

5964
All important tasks are defined in `.vscode/tasks.json` and can be run in VS Code (menu Tasks → Run Task...).

package.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
"name": "searchautocomplete",
33
"private": true,
44
"engines": {
5-
"node": ">=0.8.0"
5+
"node": ">=4"
66
},
77
"devDependencies": {
88
"babel-core": "^6.7.2",

0 commit comments

Comments
 (0)