grapher/README.md
2016-09-19 12:47:43 +03:00

48 lines
1.4 KiB
Markdown

Welcome to Grapher
==================
[![Build Status](https://api.travis-ci.org/cult-of-coders/grapher.svg)](https://api.travis-ci.org/cult-of-coders/grapher)
[![MIT licensed](https://img.shields.io/badge/license-MIT-blue.svg)](https://raw.githubusercontent.com/hyperium/hyper/master/LICENSE)
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.
Updates
-------
Check-out the [CHANGELOG](CHANGELOG.md) for latest updates.
Installation
------------
```
meteor add cultofcoders:grapher
```
Documentation
-------------
Please read the documentation:
- 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)
Useful packages and integrations
--------------------------------
#### Integration with React (cultofcoders:grapher-react)
[Atmosphere](https://atmospherejs.com/cultofcoders/grapher-react)
[GitHub](https://github.com/cult-of-coders/grapher-react/)
#### Live View (cultofcoders:grapher-live)
[Atmosphere](https://atmospherejs.com/cultofcoders/grapher-live)
[GitHub](https://github.com/cult-of-coders/grapher-live)