Skip to content

Commit aba9027

Browse files
committed
Update guides intro.
1 parent 955645a commit aba9027

File tree

1 file changed

+26
-5
lines changed

1 file changed

+26
-5
lines changed

source/guides/index.html.md

Lines changed: 26 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,11 +3,32 @@ layout: guides
33
---
44
# Introduction
55

6-
jsonapi-rb is a ruby library for producing and consuming
7-
[JSON API](http://jsonapi.org) documents. It has tight integrations with various
8-
frameworks ([Ruby on Rails](http://rubyonrails.org) and
9-
[Hanami](http://hanamirb.org) at the moment), but it is not tied to any of
10-
those.
6+
## What is jsonapi-rb?
7+
[jsonapi-rb](https://github.com/jsonapi-rb/jsonapi-rb) is a ruby library for
8+
producing and consuming [JSON API](http://jsonapi.org) documents. It is cleanly
9+
layered, has an intuitive yet intention-stating API, and no magic.
10+
11+
It is comprised of 4 independent micro-libraries:
12+
13+
+ [jsonapi-parser](https://github.com/jsonapi-rb/parser) for syntactic
14+
validation of JSON API documents,
15+
+ [jsonapi-renderer](https://github.com/jsonapi-rb/renderer) for low-level
16+
rendering of JSON API documents,
17+
+ [jsonapi-serializable](https://github.com/jsonapi-rb/serializable) for
18+
building serializable resource classes from your business object,
19+
+ [jsonapi-deserializable](https://github.com/jsonapi-rb/deserializable) for
20+
building deserializable resource classes that transform an incoming JSON API
21+
payload into a custom hash,
22+
23+
and 2 framework integrations:
24+
+ [jsonapi-rails](https://github.com/jsonapi-rb/rails) for
25+
[Ruby on Rails](http://rubyonrails.org), with ActionController integration and
26+
generators,
27+
+ [jsonapi-hanami](https://github.com/jsonapi-rb/hanami) for
28+
[Hanami](http://hanamirb.org) with Hanami::Controller::Action integration and
29+
(soon) generators.
30+
31+
## Guides
1132

1233
These guides should get you up to speed with using jsonapi-rb. If you have more
1334
questions, feel free to drop by on [Gitter](http://gitter.im/jsonapi-rb).

0 commit comments

Comments
 (0)