Skip to content

Commit

Permalink
README update, travis badge
Browse files Browse the repository at this point in the history
  • Loading branch information
tonybranfort committed Feb 8, 2016
1 parent e6e3ebe commit 2fdde1d
Showing 1 changed file with 5 additions and 3 deletions.
8 changes: 5 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
# req-uscis-status
[![NPM version](http://img.shields.io/npm/v/req-uscis-status.svg)](https://www.npmjs.org/package/apom)
<!-- [![Build Status via Travis CI](https://travis-ci.org/tonybranfort/req-uscis.svg?branch=master)](https://travis-ci.org/tonybranfort/apom) -->
<!-- [![Coverage Status](https://coveralls.io/repos/tonybranfort/req-uscis-status/badge.svg?branch=travis&service=github)](https://coveralls.io/github/tonybranfort/req-uscis-status?branch=master) -->
[![Build Status via Travis CI](https://travis-ci.org/tonybranfort/req-uscis.svg?branch=master)](https://travis-ci.org/tonybranfort/apom)
[![Coverage Status](https://coveralls.io/repos/tonybranfort/req-uscis-status/badge.svg?branch=travis&service=github)](https://coveralls.io/github/tonybranfort/req-uscis-status?branch=master)

Module to get US Citizenship and Immigration Services (USCIS) case status from the [USCIS Case Status Online](https://egov.uscis.gov/casestatus/landing.do) web page given a USCIS Receipt Number.

This is simply a screen scrape from the USCIS case status website and is not in any way affiliated with USCIS. Any changes that they make to the case status web site might and likely could impact this module.

There is just one exposed function with this module "getStatus(receiptNumber, callback)". The callback is called with an error, if any, and the result. The result is one object :
There is just one exposed function with this module ```getStatus(receiptNumber, callback)```. The callback is called with an error, if any, and the result. The result is one object :
```javascript
var statusObj = {
errHtml: undefined, // error, if any, on the uscis page from receipt number
Expand All @@ -21,6 +21,8 @@ There is just one exposed function with this module "getStatus(receiptNumber, ca

Each of the 4 properties in the status object returned are 'cleaned' of return lines, new line breaks, tabs and duplicate spaces.

Install with ```npm install req-uscis-status```.

## Examples

```javascript
Expand Down

0 comments on commit 2fdde1d

Please sign in to comment.