# bitshadowitems

> Components for Bit-Shadow Machine simulations.

Latest version **0.1.1** (published 2014-09-15) · MIT license · 0 weekly downloads

## Install

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

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned.

## Facts

| | |
|---|---|
| Version | 0.1.1 |
| Published | 2014-09-15 |
| First published | 2014-09-15 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 3 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 2 |
| Author | Vince Allen |
| Maintainers | vinceallenvince |

## Links

- npm: https://www.npmjs.com/package/bitshadowitems
- Repository: http://github.com/vinceallenvince/Bit-Shadow-Items
- Homepage: https://github.com/vinceallenvince/Bit-Shadow-Items
- Issues: https://github.com/vinceallenvince/Bit-Shadow-Items/issues
- npm.io page: https://npm.io/package/bitshadowitems

## Dependencies (3)

- [burner](https://npm.io/package/burner.md) ^3.1.5
- [quietriot](https://npm.io/package/quietriot.md) ^0.1.2
- [bitshadowmachine](https://npm.io/package/bitshadowmachine.md) ^3.0.2

## Recent versions

- 0.1.1 (latest) — 2014-09-15

## README

![Build status](https://travis-ci.org/vinceallenvince/bitshadowitems.svg?branch=master)

# bitshadowitems

Components for Bit-Shadow Machine simulations.

##Install

To include bitshadowitems as a component in your project, use the node module.

```
npm install bitshadowitems --save
```

You can also use the [standalone version](https://github.com/vinceallenvince/bitshadowitems/releases/latest) and reference the js file from your document.

```
<html>
  <head>
    <script src="scripts/bitshadowitems.min.js" type="text/javascript" charset="utf-8"></script>
  </head>
  ...
```

##Usage

Please review [the docs](http://vinceallenvince.github.io/bitshadowitems/doc/) for more details.

##Building this project

This project uses [Grunt](http://gruntjs.com). To build the project first install the node modules.

```
npm install
```

Next, run grunt.

```
grunt
```

To run the tests, run 'npm test'.

```
npm test
```

To check test coverage run 'grunt coverage'.

```
grunt coverage
```

A pre-commit hook is defined in /pre-commit that runs jshint. To use the hook, run the following:

```
ln -s ../../pre-commit .git/hooks/pre-commit
```

A post-commit hook is defined in /post-commit that runs the Plato complexity analysis tools. To use the hook, run the following:

```
ln -s ../../post-commit .git/hooks/post-commit
```

View the [code complexity](http://vinceallenvince.github.io/bitshadowitems/reports/) report.

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