ash_graphql/README.md

28 lines
1.2 KiB
Markdown
Raw Normal View History

2020-05-02 04:32:56 +12:00
# AshGraphql
2020-08-14 10:55:34 +12:00
![Elixir CI](https://github.com/ash-project/ash_graphql/workflows/Elixir%20CI/badge.svg)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
[![Coverage Status](https://coveralls.io/repos/github/ash-project/ash_graphql/badge.svg?branch=master)](https://coveralls.io/github/ash-project/ash_graphql?branch=master)
[![Hex version badge](https://img.shields.io/hexpm/v/ash_graphql.svg)](https://hex.pm/packages/ash_graphql)
2020-05-02 04:32:56 +12:00
2020-08-14 10:55:34 +12:00
AshGraphql is a graphql front extension for the Ash framework. V
See the getting started guide for information on setting it up, and see the `AshGraphql.Resource` documentation for docs on its DSL. See the hexdocs for more information.
2020-05-02 04:32:56 +12:00
## Installation
If [available in Hex](https://hex.pm/docs/publish), the package can be installed
by adding `ash_graphql` to your list of dependencies in `mix.exs`:
```elixir
def deps do
[
2020-08-15 02:20:58 +12:00
{:ash_graphql, "~> 0.1.2"}
2020-05-02 04:32:56 +12:00
]
end
```
Documentation can be generated with [ExDoc](https://github.com/elixir-lang/ex_doc)
and published on [HexDocs](https://hexdocs.pm). Once published, the docs can
be found at [https://hexdocs.pm/ash_graphql](https://hexdocs.pm/ash_graphql).