diff --git a/packages/babel-helper-fixtures/README.md b/packages/babel-helper-fixtures/README.md index 57107d89f5..f27fd6af74 100644 --- a/packages/babel-helper-fixtures/README.md +++ b/packages/babel-helper-fixtures/README.md @@ -1 +1,31 @@ # babel-helper-fixtures + +## Usage + +```javascript +import { get as getFixtures } from "babel-helper-fixtures"; + +type TestFile = { + loc: string; + code: string; + filename: string; +}; + +type Test = { + title: string; + disabled: boolean; + options: Object; + exec: TestFile; + actual: TestFile; + expected: TestFile; +}; + +type Suite = { + options: Object; + tests: Array; + title: string; + filename: string; +}; + +let fixtures: Array = getFixtures("/User/sebmck/Projects/babel-something/test/fixtures"); +```