Skip to content

Commit

Permalink
Adds basic groups (minor)
Browse files Browse the repository at this point in the history
  • Loading branch information
zrrrzzt committed Jun 21, 2018
1 parent 812f5d5 commit 6577577
Show file tree
Hide file tree
Showing 9 changed files with 1,555 additions and 14 deletions.
2 changes: 1 addition & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -47,4 +47,4 @@ jspm_packages
package-lock.json

# env
.env
.env
2 changes: 1 addition & 1 deletion .travis.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
language: node_js
node_js:
- "8"
- "10"
after_success:
- npm run coveralls
21 changes: 18 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@

# tfk-schools-info

[![Greenkeeper badge](https://badges.greenkeeper.io/telemark/tfk-schools-info.svg)](https://greenkeeper.io/)
Information regarding our schools

## Installation
Expand All @@ -31,7 +30,6 @@ Possible keys:
- **mail**

```JavasScript
'use strict'
const getSchools = require('tfk-schools-info')
const options = {
Expand All @@ -43,8 +41,25 @@ console.log(getSchools()) //=> All schools
console.log(getSchools(options)) //=> Schools with shortName SKIVS
```

### Basic groups

To list all basic groups from a school

```JavaScript
const { getGroups } = require('tfk-schools-info')

console.log(getGroups('SKIVS'))
```
To list all groups for all schools

```JavaScript
const { getGroups } = require('tfk-schools-info')

console.log(getGroups())
```

## License

[MIT](LICENSE)

![alt text](https://robots.kebabstudios.party/tfk-schools-info.png "Robohash image of tfk-schools-info")
![Robohash image of tfk-schools-info](https://robots.kebabstudios.party/tfk-schools-info.png "Robohash image of tfk-schools-info")
4 changes: 2 additions & 2 deletions index.js
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
'use strict'

const getSchools = require('./lib/get-schools')

module.exports = options => {
return getSchools(options)
}

module.exports.getGroups = require('./lib/get-groups')
Loading

0 comments on commit 6577577

Please sign in to comment.