diff --git a/README.md b/README.md new file mode 100644 index 0000000..dd97d4e --- /dev/null +++ b/README.md @@ -0,0 +1,11 @@ +# PB Parser + +This module parses [.pb files](https://github.com/google/fonts/blob/main/ofl/poppins/METADATA.pb) + +## Usage + +1. Install the package using: + * `npm install git+https://git.sofiaritz.com/sofia/pb-parser.git` + * `yarn add git+https://git.sofiaritz.com/sofia/pb-parser` + +2. Use the `#parse()` function to parse a whole file. diff --git a/index.js b/index.js index e3ef8b8..8ef05ee 100644 --- a/index.js +++ b/index.js @@ -1,7 +1,7 @@ import {deepStrictEqual} from "assert"; /** - * Parses a PB file as found in the [Google Fonts Repository](https://github.com/google/fonts/blob/main/ofl/wixmadefordisplay/METADATA.pb) + * Parses a PB single .pb file * @param{string} rinput * @return{Object} */