README_TEMPLATE.md

LocalBoast - Making Web Development Harder for Myself.

INSERT_BANNER_HERE

INSERT_SHIELDS_HERE

What is it?

LocalBoast is a React library developed with a view to creating spectacle with as little effort as possible. If something doesn't sound very practical but would probably look cool, it belongs here.

The intention is to remain with zero dependencies (other than some borrowed code here and there) so a lot of the library consists of common functions from other repos (function debouncing, resize detection etc.) but with an API that's custom-built to work with the flashier parts of this library. So yes, some wheels are being reinvented in the name of creating a pointlessly flashy car but, in fairness, most wheels are boring.

INSERT_HOW_TO_INSTALL_HERE

Contents

INSERT_CONTENTS_HERE

To Use

This library includes a range of Components, Hooks and Utils. These are all able to be used independently and are intended to provide quick access to powerful functionality.

All public elements of this library are exported from the root index, allowing for simple imports like:

import { Truncate, useMove, debounce } from "localboast"

Each of the core folders also provides an index of the exported contents, potentially saving on some unneeded imports:

import { Truncate } from "localboast/components"
import { useMove } from "localboast/hooks"
import { debounce } from "localboast/utils"

Each module can also be imported directly from their own folder, allowing for largest optimization:

import Truncate from "localboast/components/Truncate"
import useMove from "localboast/hooks/useMove"
import debounce from "localboast/utils/debounce"

INSERT_FOOTER_HERE