# agastya

> Web accessibility made simple

Latest version **4.2.0** (published 2019-06-11) · MIT license · 0 weekly downloads

## Install

```sh
npm install agastya
pnpm add agastya
yarn add agastya
bun add agastya
```

## Health

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

Positive: has types; esm support; no vulnerabilities; high quality score.

Warnings: low downloads.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 4.2.0 |
| Published | 2019-06-11 |
| First published | 2017-12-08 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 1 |
| Unpacked size | 11.8 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Anand Chowdhary |
| Maintainers | anandchowdhary |

## Links

- npm: https://www.npmjs.com/package/agastya
- Repository: https://github.com/AnandChowdhary/agastya
- Homepage: https://github.com/AnandChowdhary/agastya#readme
- Issues: https://github.com/AnandChowdhary/agastya/issues
- npm.io page: https://npm.io/package/agastya

## Dependencies (1)

- [scriptjs](https://npm.io/package/scriptjs.md) ^2.5.9

## Recent versions

- 4.2.0 (latest) — 2019-06-11
- 4.1.0 — 2019-05-28
- 4.0.0 — 2019-04-08
- 3.0.0 — 2019-03-25
- 2.0.1 — 2018-12-21
- 2.0.0 — 2018-12-21
- 1.0.3 — 2017-12-08
- 1.0.2 — 2017-12-08
- 1.0.1 — 2017-12-08
- 1.0.0 — 2017-12-08

## README

# ♿ Agastya

![Travis CI](https://travis-ci.org/OswaldLabsOpenSource/agastya.svg?branch=master)
![Dependencies](https://img.shields.io/david/OswaldLabsOpenSource/agastya.svg)
![Dev dependencies](https://img.shields.io/david/dev/OswaldLabsOpenSource/agastya.svg)
[![License](https://img.shields.io/github/license/OswaldLabsOpenSource/agastya.svg)](https://github.com/OswaldLabsOpenSource/agastya/blob/master/LICENSE)
![Vulnerabilities](https://img.shields.io/snyk/vulnerabilities/github/OswaldLabsOpenSource/agastya.svg)
![Bundle size](https://img.shields.io/bundlephobia/minzip/agastya.svg)

## 📦 Get Started

```bash
yarn add agastya
```

```js
// Import or require Agastya
import Agastya from "agastya";

// Initialize Agastya with your API key
const agastya = new Agastya("API_KEY");
```

Optionally, you can use a specific channel:

```js
const agastya = new Agastya("API_KEY", "production"); // Production (default)
const agastya = new Agastya("API_KEY", "beta"); // Beta (stable)
const agastya = new Agastya("API_KEY", "dev"); // Nighly/development (breaking changes)
```

You can also use the official CDN instead:

```html
<script async src="https://platform.oswaldlabs.com/_/API_KEY.js"></script>
```

Once you've created the Agastya object, you can start using the API:

```js
agastya.open(); // Open the Agastya widget
agastya.api("enableMode", "read-aloud"); // Start read aloud mode
agastya.secureTrack({ hello: "world" }); // Track a custom event
```

## [API Documentation](https://help.oswaldlabs.com/developers/)

- [Getting started](https://help.oswaldlabs.com/developers/)
- [Installation](https://help.oswaldlabs.com/developers/installation.html)
- [API basics](https://help.oswaldlabs.com/developers/api.html)
- [Widget manipulation](https://help.oswaldlabs.com/developers/widget.html)
- [Listening for events](https://help.oswaldlabs.com/developers/events.html)
- [Tracking and data](https://help.oswaldlabs.com/developers/tracking.html)
- [Apps and modes](https://help.oswaldlabs.com/developers/modes.html)
- [Integrations](https://help.oswaldlabs.com/developers/integrations.html)
- [Embeds](https://help.oswaldlabs.com/developers/embeds.html)

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