Skip to content

Commit

Permalink
Add badges to README
Browse files Browse the repository at this point in the history
  • Loading branch information
georgeben committed Jun 21, 2019
1 parent 737c015 commit 88d44f9
Showing 1 changed file with 9 additions and 2 deletions.
11 changes: 9 additions & 2 deletions README.md
@@ -1,14 +1,21 @@
# ng_universities
A package to retrieve the list of universities in Nigeria approved by the Nigerian University Commission (NUC)

[![Build Status](https://travis-ci.org/georgeben/ng_universities.svg?branch=master)](https://travis-ci.org/georgeben/ng_universities)

[![Coverage Status](https://coveralls.io/repos/github/georgeben/ng_universities/badge.svg?branch=master)](https://coveralls.io/github/georgeben/ng_universities?branch=master)

## Getting started.
Install this package from npm by running the command `npm install ng_universities`

## API
```js
var ng_universities = require('ng_universities')
```

### getUniversities(category)
The getUniversities() function takes in a category of the university which can be "public", "private", "federal" or "state" and returns the list of universities.
If no parameter is supplied, getUniversities() returns a list of all the universities.
The `getUniversities()` function takes in a category of the university which can be "public", "private", "federal" or "state" and returns the list of universities.
If no parameter is supplied, `getUniversities()` returns a list of all the universities.


```js
Expand Down

0 comments on commit 88d44f9

Please sign in to comment.