react-amiga-guru-meditation/README.md

A React Error Boundary styled like the Amiga Guru Meditation

# Overview

![version](https://img.shields.io/npm/v/react-amiga-guru-meditation.svg)
![license](https://img.shields.io/npm/l/react-amiga-guru-meditation.svg)
![issues](https://img.shields.io/github/issues/gfazioli/react-amiga-guru-meditation.svg)
![type](https://img.shields.io/npm/types/react-amiga-guru-meditation.svg)
![last-commit](https://img.shields.io/github/last-commit/gfazioli/react-amiga-guru-meditation.svg)
![npm](https://img.shields.io/npm/dm/react-amiga-guru-meditation.svg)


This component is designed to render a funny Error Boundary styled like the old Amiga Guru Meditation.

![image](./image.png)

## New in v2.0.x

* Use Typescript
* Use React Hooks
* New [Documentation and Intercative Playground](https://gfazioli.github.io/react-amiga-guru-meditation/)

## Installation

You can use either **npm**

```bash
npm i react-amiga-guru-meditation
```

or **yarn**

```bash
yarn add react-amiga-guru-meditation
```

## Basic Usage

First of all, remember to import the component.

```jsx
import React from "react"

import {AmigaErrorBoundary} from "react-amiga-guru-meditation"

function Application() {

  return (
    <AmigaErrorBoundary>
      <h1>Protected code</h1>
    </AmigaErrorBoundary>
  );
}
```

## Documentation

See the complete [documentation and intercative playground](https://gfazioli.github.io/react-react-amiga-guru-meditation/)


## Contributing

Thanks for any your contribute 👏.

## Bugs 🐛

Use the GitHub issues.

## License

MIT Licensed. Copyright (c) Giovambattista Fazioli 2019.