diff --git a/README.md b/README.md new file mode 100644 index 0000000..f8e4af3 --- /dev/null +++ b/README.md @@ -0,0 +1,11 @@ +# GFonts JS Library + +This module provides useful functions for its usage in GFonts projects. +* Retrieval of font metadata +* Parsing of CSS2 specs + +## Usage +1. Install the package using: + * `npm install git+https://git.sofiaritz.com/GFonts/gfonts-js-library.git` + * `yarn add git+https://git.sofiaritz.com/GFonts/gfonts-js-library` +2. Use the functions provided by the module.