grapher/README.md

37 lines
967 B
Markdown
Raw Normal View History

2016-09-14 16:04:08 +03:00
Welcome to Grapher
==================
[![Build Status](https://api.travis-ci.org/cult-of-coders/grapher.svg)](https://api.travis-ci.org/cult-of-coders/grapher)
2016-09-16 19:22:12 +03:00
[![MIT licensed](https://img.shields.io/badge/license-MIT-blue.svg)](https://raw.githubusercontent.com/hyperium/hyper/master/LICENSE)
2016-09-14 16:04:08 +03:00
General
-------
*Grapher* is a Meteor package that will:
1. Allow you to work with Joins (also known as: Relationships or Links) between Collections;
2. Expose reactive/non-reactive fetching abilities using a GraphQL like syntax.
2016-09-14 16:04:08 +03:00
2016-09-16 19:22:12 +03:00
Updates
-------
Check-out the [CHANGELOG](CHANGELOG.md) for latest updates.
2016-09-15 11:17:23 +03:00
Installation
------------
```
meteor add cultofcoders:grapher
```
2016-09-16 19:22:12 +03:00
2016-09-14 16:04:08 +03:00
Documentation
-------------
Please read the documentation:
2016-09-15 09:14:15 +03:00
- How to link collections ? [Collection Links](docs/links.md)
- How to securely expose data ? [Exposing Collections](docs/exposure.md)
- How to search for the data ? [Query](docs/query.md)
API
---
[Quick Reference API](docs/api.md)