Skip to content

Commit

Permalink
add badges and usage
Browse files Browse the repository at this point in the history
  • Loading branch information
dangowans committed Mar 4, 2024
1 parent 074fb55 commit e6ef37a
Showing 1 changed file with 19 additions and 0 deletions.
19 changes: 19 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,24 @@
# NCIC Lookup

[![DeepSource](https://app.deepsource.com/gh/cityssm/node-ncic-lookup.svg/?label=active+issues&show_trend=true&token=wV_h2WD2q1m0xm80kHAXVGGC)](https://app.deepsource.com/gh/cityssm/node-ncic-lookup/)
[![Maintainability](https://api.codeclimate.com/v1/badges/1fed08589ce516f0ff69/maintainability)](https://codeclimate.com/github/cityssm/node-ncic-lookup/maintainability)
[![codecov](https://codecov.io/gh/cityssm/node-ncic-lookup/graph/badge.svg?token=8BCT6BZDU8)](https://codecov.io/gh/cityssm/node-ncic-lookup)

Lookups and helper functions for FBI National Crime and Information Center (NCIC) codes.

Built using the XSD file from the [National Information Exchange Model (NEIM) 5.0](https://release.niem.gov/niem/5.0/).

## Installation

```sh
npm install @cityssm/ncic-lookup
```

## Usage

```javascript
import * as ncicLookup from '@cityssm/ncic-lookup'

console.log(await ncicLookup.getFieldValueDescription('VMA', 'GMC'))
// "GENERAL MOTORS CORP."
```

0 comments on commit e6ef37a

Please sign in to comment.