diff --git a/README.md b/README.md new file mode 100644 index 0000000..b4bc4a1 --- /dev/null +++ b/README.md @@ -0,0 +1,30 @@ + +# :dollar: Kobo Price + +Helps you find the lowest book price on kobo.com. + +![example](./img/example.gif) + +## Installation +You can install this script in several ways: + +- [Firefox add-on](https://addons.mozilla.org/en-US/firefox/addon/kobo-price) +- [Chrome extension](https://chromewebstore.google.com/detail/kobo-price/gjiadglcgiidfphjijgeellagidbkiah) +- [Userscript](https://raw.githubusercontent.com/fotonmoton/koboprice/master/userscript/koboprice.user.js) + +## Usage +On kobo.com, the book price for each country could be different. This script will fetch all book prices, convert them to USD at today's rate, sort them, and show to you as a list. Then you can change your billing address to the country whose price you like and proceed to checkout. + +- Go to the book/audiobook page you want to buy +- wait a couple of minutes until all the prices are loaded (you should see the progress on the right side of the book page) +- get the list of prices sorted and converted to USD + +## Build + +All artifacts are based on the `dist/index.js` bundle. To get it, run `npm run bundle`. To get the web extension archive, run `npm run build-ext`. To get the userscript, run `npm run build-userscript`. + +To get all the above: + +```sh +npm install && npm build-all +``` \ No newline at end of file diff --git a/img/example.gif b/img/example.gif new file mode 100644 index 0000000..0d02fe8 Binary files /dev/null and b/img/example.gif differ diff --git a/package.json b/package.json index 00b5329..a1dd55d 100644 --- a/package.json +++ b/package.json @@ -12,8 +12,8 @@ "watch-ext": "web-ext run --start-url https://www.kobo.com/ww/en/ebook/foundation-the-foundation-trilogy-book-1-1", "watch": "concurrently npm:watch-bundle npm:watch-ext", "build-userscript": "cat userscript/koboprice.meta.js dist/index.js > userscript/koboprice.user.js", - "ext-build": "web-ext build", - "build-all": "npm run bundle && npm run build-userscript && npm run ext-build" + "build-ext": "web-ext build", + "build-all": "npm run bundle && npm run build-userscript && npm run build-ext" }, "author": "", "license": "ISC",