Skip to content
/ index Public

A simple library to handle a directory of users and groups.

License

Notifications You must be signed in to change notification settings

Eldynn/index

Repository files navigation

Top Language License npm bundle size

Version CircleCI Code Quality Code Coverage

devDependencies Greenkeeper Code style Commitizen

Description

A simple library to handle a directory of users and groups.

Usage

In browser environment

Extract the latest release.

then

<script type="text/javascript" src="Index/index.js"></script>
<script type="text/javascript">
  console.info(Index.Index, Index.User, Index.Group, Index.Member);
</script>

or (recommended)

<script type="module">
  import { Index, User, Group, Member } from './Index/index.esm.js';
</script>

In node environment

npm install @eldynn/index

import { Index, User, Group, Member } from '@eldynn/index';

Class Diagram

Contribute

If you want to contribute read this guide.

Use npm run build, the output is located in build/

Use npm test to run the test suites

Use npm run docs to generate the documentation in docs/