README.md

Introduction

You're excited and ready to start creating fixture data for your project. Awesome 🙌 (us too!). Before you start, you'll need to get setup.

To get started, install Helix by entering the npm install command above (or use yarn add).

npm install @helpscout/helix --save-dev

Now that you have Helix installed in your project, you'll need to import both createSpec and faker from Helix.

import { createSpec, faker } from '@helpscout/helix'

Note: If you're using require, you can do:

const helix = require('@helpscout/helix')
const createSpec = helix.createSpec
const faker = helix.faker