@allenai/varnish-react-router/README.md

An extension to Varnish for applications that use React Router.

# varnish-react-router

An extension to [Varnish](http://github.com/allenai/varnish) for applications that use [React Router](https://github.com/ReactTraining/react-router).

## Usage

First install the package:

```bash
yarn add @allenai/varnish-react-router
```

Then you can use it like so:

```tsx
import { ThemeProvider } from '@allenai/varnish';
import { Link } from '@allenai/varnish-react-router';
import '@allenai/varnish/varnish.css';

const App = () => (
  <ThemeProvider>
    <Link to="/some/path">Click Here</InternalLink>
  </ThemeProvider>
);
```

See: [Varnish documentation](https://varnish.allenai.org/components/varnish-react-router) for more example usage.

## Contributing

Examples of this library are shown in the Varnish Demo.
You can utilize the root Varnish Monorepo Docker setup by running `docker-compose up --build`.
From there you will be able to see demos at https://localhost:8080/components/varnish-react-route

## Publishing

See instructions at the monorepo root [README](../../README.md)

## Getting Help

If you're stuck don't hesitate to reach out:

-   Sending an email to [reviz@allenai.org](mailto:reviz@allenai.org)
-   Joining the `#skiff-users` slack channel
-   Opening a [Github Issue](https://github.com/allenai/varnish/issues/new)

We're eager to improve `varnish` and need your feedback to do so!