nanosplash/README.md

The tiny loading screen for web artisans

# Nanosplash

**The tiny loading screen for web artisans**

[![CI Production: Build, Test](https://github.com/isakhauge/nanosplash/actions/workflows/ci.yml/badge.svg)](https://github.com/isakhauge/nanosplash/actions/workflows/ci.yml)
[![Coverage Status](https://coveralls.io/repos/github/isakhauge/nanosplash/badge.svg?branch=main)](https://coveralls.io/github/isakhauge/nanosplash?branch=main)

---

```js
// Fullscreen
ns.show('Loading')

// Specific element
ns.show('Loading', '#my-div')

// Hide
ns.hide()
```

## Installation
Add to your project and get the typing and docs.
```bash
npm install nanosplash
```

Or add the script tag to your HTML.
```html
<script src="https://unpkg.com/nanosplash/dist/iife/ns.iife.js"></script>
```

## Documentation
[Read the full docs here](./docs.md)