Expose getFontDetails API

Author: ayushjainrksh

.eslintrc.json

@@ -0,0 +1,29 @@
+{
+    "env": {
+        "browser": true,
+        "es2021": true
+    },
+    "extends": [
+        "standard-with-typescript",
+        "plugin:react/recommended"
+    ],
+    "parserOptions": {
+        "ecmaVersion": "latest",
+        "sourceType": "module",
+        "project": ["./tsconfig.json"]
+    },
+    "plugins": [
+        "react"
+    ],
+    "rules": {
+        "react/prop-types": 0,
+        "indent": ["error", 2],
+        "no-trailing-spaces": ["error"],
+        "quotes": ["error", "single"],
+        "no-multiple-empty-lines": ["error", { "max": 1, "maxEOF": 0 }],
+        "semi": ["error", "always"],
+        "space-infix-ops": "error",
+        "@typescript-eslint/semi": ["error", "always"],
+        "@typescript-eslint/strict-boolean-expressions": "off"
+    }
+}

.nvmrc

@@ -0,0 +1 @@
+v18.12.1

README.md

@@ -37,3 +37,24 @@ You can customize the `<FontPreview />` component by either wrapping it in an el
 and customizing the element or by adding styles to the class `font-preview` in your
 css file. `font-preview` is the class assigned to the `div` that displays the text
 with font-preview.
+
+## APIs
+### getFontDetails
+This function returns a promise that resolves to an object containing the font details.
+Returns an object that contains the following properties:
+- fontFamily: The font family name
+- fullName: The full name of the font
+- version: The version of the font
+- manufacturer: The manufacturer of the font
+- designer: The designer of the font
+- licence: The licence of the font 
+
+```javascript
+  import { getFontDetails } from 'font-preview';
+
+  // Accepts font file url
+  const fontMeta = await getFontDetails(fontUrl);
+
+  // Accepts loaded font file buffer
+  const fontMeta = await getFontDetails(fontBuffer);
+```