# shared-views

[![Build Status](https://travis-ci.org/anyWareSculpture/shared-views.svg?branch=master)](https://travis-ci.org/anyWareSculpture/shared-views)

[![codecov.io](http://codecov.io/github/anyWareSculpture/shared-views/coverage.svg?branch=master)](http://codecov.io/github/anyWareSculpture/shared-views?branch=master)

![codecov.io](http://codecov.io/github/anyWareSculpture/shared-views/branch.svg?branch=master)

## Usage
This library models the game logic shared by all anyWare implementations.

When installed (or built), modules are stored in a `lib/` directory. Thus when requiring files, make sure that you are adding that before the path of the file you are requiring. In addition, ensure that you are requiring each individual file. `require('@anyware/shared-views')` alone will not work.

Example of correct usage:

    const MyThing = require('@anyware/shared-views/lib/things/my-thing');

This was implemented this way for a variety of reasons:

1. Requiring individual files only gets those files and their dependencies. That way it isn't necessary to include the entire library if you only need a few parts.
2. This means that we don't have to keep any `index.js` or something up to date all the time. You can access whatever you want using the `lib/` directory.


# shared-views

[![Build Status](https://travis-ci.org/anyWareSculpture/shared-views.svg?branch=master)](https://travis-ci.org/anyWareSculpture/shared-views)

[![codecov.io](http://codecov.io/github/anyWareSculpture/shared-views/coverage.svg?branch=master)](http://codecov.io/github/anyWareSculpture/shared-views?branch=master)

![codecov.io](http://codecov.io/github/anyWareSculpture/shared-views/branch.svg?branch=master)

## Usage

This repository contains shared views used by multiple anyWare runtimes.

When installed (or built), modules are stored in a `lib/` directory. Thus when requiring files, make sure that you are adding that before the path of the file you are requiring. In addition, ensure that you are requiring each individual file. `require('@anyware/shared-views')` alone will not work.

Example of correct usage:

    const AudioView = require('@anyware/shared-views/lib/audio-view);

This was implemented this way for a variety of reasons:

1. Requiring individual files only gets those files and their dependencies. That way it isn't necessary to include the entire library if you only need a few parts.
2. This means that we don't have to keep any `index.js` or something up to date all the time. You can access whatever you want using the `lib/` directory.


Clarify that this is about views ahared between runtimes
Clarify that this is about views ahared between runtimes
