# overview-interactive

> fetch and display a spruced-up overview file in your browser

Latest version **1.0.0** (published 2015-09-23) · ISC license · 0 weekly downloads

## Install

```sh
npm install overview-interactive
pnpm add overview-interactive
yarn add overview-interactive
bun add overview-interactive
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.0 |
| Published | 2015-09-23 |
| First published | 2015-09-23 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Daniel Montague |
| Maintainers | atstp |

## Links

- npm: https://www.npmjs.com/package/overview-interactive
- Repository: https://github.com/atstp/overview-interactive
- Issues: https://github.com/atstp/overview-interactive/issues
- npm.io page: https://npm.io/package/overview-interactive

## Dependencies (1)

- [babel-core](https://npm.io/package/babel-core.md) ^5.8.25

## Recent versions

- 1.0.0 (latest) — 2015-09-23

## README

# overview-interactive

this is a concise ES6 project for fetching an `OVERVIEW` file
and rendering an intuitive interface for it in the browser.

basically, in addition to a sweet project overview living inside
your project as a text file, this can bring that file to life in
your docs.

    npm install overview-interactive

-----

minimal example

    <html>
      <h1> overview-interactive demo </h1>
      <div id="demo-here"></div>
      <script src="overview-interactive.js"></script>
      <script>
        var overviewFileURL = 'https://raw.githubusercontent.com' +
                     '/atstp/overview-interactive/master/OVERVIEW';
        overview(overviewFileURL, proj => proj.into('#demo-here'));
      </script>

---
_Source: https://npm.io/package/overview-interactive · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
