Merge pull request #36 from twingly/remove-jsdoc

Remove JSDoc from package.json

README.md

@@ -34,12 +34,15 @@ query.execute(function(error, result){
 
 The `twingly-search` library talks to a commercial blog search API and requires an API key. Best practice is to set the `TWINGLY_SEARCH_KEY` environment variable to the obtained key. `Client` can be passed a key at initialization if your setup does not allow environment variables.
 
-The library is documented with [jsdoc](http://usejsdoc.org/). To generate the documentation run
+The library is documented with [JSDoc](https://github.com/jsdoc3/jsdoc). To generate the documentation, you need to install JSDoc, and then generate the documentation.
 
 ```shell
-npm run doc
+npm install -g jsdoc
+jsdoc -r ./lib
 ```
 
+Find the generated documentation in `out/index.html`.
+
 Example code can be found in [examples/](examples/).
 
 To learn more about the capabilities of the API, please read the [Twingly Search API documentation](https://developer.twingly.com/resources/search/).

package.json

@@ -15,15 +15,13 @@
     "chai-datetime": "^1.4.0",
     "chai-fuzzy": "^1.6.0",
     "choma": "^1.2.1",
-    "jsdoc": "^3.4.0",
     "mocha": "^5.2.0",
     "replayer": "^2.2.3"
   },
   "scripts": {
     "preversion": "npm test",
     "postversion": "git push && git push --tags",
-    "test": "./node_modules/.bin/mocha",
-    "doc": "./node_modules/.bin/jsdoc -r ./lib"
+    "test": "./node_modules/.bin/mocha"
   },
   "author": "Twingly AB <support@twingly.com> (https://twingly.com/)",
   "contributors": [