Skip to content

Commit

Permalink
Updated the documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
cedx committed Nov 9, 2016
1 parent 9a4ac7d commit 5170ac4
Show file tree
Hide file tree
Showing 3 changed files with 11 additions and 7 deletions.
6 changes: 5 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,11 @@
# Changelog
This file contains highlights of what changes on each version of the [Akismet for JS](https://github.com/cedx/akismet.js) library.

## Version 1.0.2
## Version 2.0.0
- Breaking change: removed the `Client.serviceURL` property.
- Breaking change: removed the `EndPoints` enumeration.
- Breaking change: renamed the `Client.DEFAULT_SERVICE` property to `SERVICE_URL`.
- Updated the package dependencies.
- Updated the project URL.

## Version 1.0.1
Expand Down
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -72,11 +72,11 @@ promise.then(isSpam =>
```

## Unit Tests
In order to run the tests, you must set one or several environment variables:
In order to run the tests, you must set the `AKISMET_API_KEY` environment variable to the value of your Akismet API key:

- `AKISMET_API_KEY`: the Akismet API key (required).
- `AKISMET_BLOG`: the front page or home URL (optional).
- `AKISMET_SERVICE_URL`: the URL of the remote service (optional).
```shell
$ export AKISMET_API_KEY=<YourApiKey>
```

Then, you can run the `test` script from the command prompt:

Expand Down
4 changes: 2 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
"bugs": "https://github.com/cedx/akismet.js/issues",
"license": "Apache-2.0",
"repository": "cedx/akismet.js",
"version": "1.0.1",
"version": "2.0.0",

"jsnext:main": "./src/index",
"main": "./lib/index",
Expand All @@ -17,7 +17,7 @@
"superagent": "^2.3.0"
},
"devDependencies": {
"@cedx/gulp-david": "^3.0.0",
"@cedx/gulp-david": "^3.0.2",
"babel-preset-latest": "^6.16.0",
"babel-register": "^6.18.0",
"codacy-coverage": "^2.0.0",
Expand Down

0 comments on commit 5170ac4

Please sign in to comment.