diff --git a/README.md b/README.md index 5ab182e..0dab3aa 100644 --- a/README.md +++ b/README.md @@ -8,14 +8,17 @@ Currently supports the following providers: |--------|-----| |OpenLibrary|ISBN| -## Usage +## Installation -```javascript -const E = require('epub-metadata-generator') -E.write(filepath, ISBN); +You can install it from NPM + +``` +npm i -g epub-metadata-generator ``` -Alternatively, you can use the provided command-line-executable: +## Usage + +You can use the provided command-line-executable: ```sh generate-epub-xml 9780596101190 /tmp/9780596101190.xml @@ -41,6 +44,13 @@ You can use this file in `pandoc` directly: `pandoc input.html --epub-metadata=/tmp/9780596101190.xml file.epub` +Alternatively, you can use the NPM package programatically as well: + +```javascript +const E = require('epub-metadata-generator') +E.write(filepath, ISBN); +``` + ## License Licensed under the [MIT License](https://nemo.mit-license.org/). See LICENSE file for details.