Synopsis

Recipe related static data, like ingredients, recipes, diets, allergies, etc.

Code Example

Show what the library does as concisely as possible, developers should be able to figure out how your project solves their problem by looking at the code example. Make sure the API you are showing off is obvious, and that your code is short and concise.

Motivation

In a few our projects we have a similar files. And we always copy-paste code between them. So by moving this code into separated place - i hope we'll make our projects better.

Installation

Provide code examples and explanations of how to get the project. npm install @groceristar/static-data

Usage

  var data = require('@groceristar/static-data');
  console.log(data);

  import data from '@groceristar/static-data'

API Reference

Depending on the size of the project, if it is small and simple enough the reference docs can be added to the README. For medium size to larger projects it is important to at least provide a link to where the API reference docs live.

Tests

npm test

Contributors

Let people know how they can dive into the project, include important links to things like issue trackers, irc, twitter accounts if applicable.