diff --git a/README.md b/README.md index b24d5e3..a560935 100644 --- a/README.md +++ b/README.md @@ -1 +1,94 @@ -# Armco Template for the tech stack: React, TS, Dart Sass, Redux Tookkit, react-redux, react browser routing, TS based plop generator \ No newline at end of file +# @armco/font-spot + +> Font Browser UI for Armco Platform + +font-spot is a React-based font browser that provides browsing, searching, and previewing capabilities for fonts served by ArmoryStatic. + +## Features + +- **Font Grid**: Visual font browser with live preview +- **Search**: Text search with debounce +- **Pagination**: Page-based navigation +- **Live Preview**: Fonts render in their own typeface + +## Installation + +```bash +pnpm add @armco/font-spot +``` + +## Peer Dependencies + +```json +{ + "@armco/components": "^0.0.60", + "@armco/configs": "^0.0.11", + "@armco/types": "^0.0.18", + "@armco/utils": "^0.0.29", + "react": "^18.2.0", + "react-dom": "^18.2.0" +} +``` + +## Usage + +```tsx +import Fonts from "@armco/font-spot" + +function App() { + return ( +