Add README
This commit is contained in:
parent
d344e3fa7a
commit
3bc8a84523
2 changed files with 12 additions and 1 deletions
11
README.md
Normal file
11
README.md
Normal file
|
@ -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.
|
2
index.js
2
index.js
|
@ -1,7 +1,7 @@
|
||||||
import {deepStrictEqual} from "assert";
|
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
|
* @param{string} rinput
|
||||||
* @return{Object}
|
* @return{Object}
|
||||||
*/
|
*/
|
||||||
|
|
Loading…
Reference in a new issue