An open API service indexing awesome lists of open source software.

https://github.com/cludden/transit-rest-api

transit.js query parser
https://github.com/cludden/transit-rest-api

Last synced: 2 months ago
JSON representation

transit.js query parser

Awesome Lists containing this project

README

        

# transit-rest-api
a [transit-js](https://github.com/cognitect/transit-js) based query parser for rest apis that follow the [json-api](http://jsonapi.org/) spec.

*note: currently under active development and not suitable for use*

## Installing
Install with npm:
```bas
npm install --save transit-rest-api
```

## Getting Started
*Coming soon...*

## API
*Coming soon...*

## Testing
run the test suite
```bash
npm test
```

run coverage via [istanbul](https://github.com/gotwarlost/istanbul)
```bash
grunt coverage
```

## Contributing
1. [Fork it](https://github.com/cludden/transit-rest-api/fork)
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -am 'Add some feature'`)
4. Push to the branch (`git push origin my-new-feature`)
5. Create new Pull Request

## License
Copyright (c) 2016 Chris Ludden.
Licensed under the [MIT license](LICENSE.md).