licence and begin readme

This commit is contained in:
Sam Woodard 2015-07-08 16:48:13 -07:00
parent 7430fd0b0c
commit fcfbda00d2
3 changed files with 44 additions and 0 deletions

2
.gitignore vendored
View File

@ -1 +1,3 @@
/bin/
/pkg/
/src/

21
LICENSE Normal file
View File

@ -0,0 +1,21 @@
The MIT License (MIT)
Copyright (c) 2015 Sam Woodard
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.

21
README.md Normal file
View File

@ -0,0 +1,21 @@
# jsonapi
A serailizer/deserializer for json payloads that comply to the
[jsonapi.org](http://jsonapi.org) spec in go.
## Background
You are working in your Go web application and you have a struct that is
similar to how your datbase table looks. You need to send and receive
json payloads that adhere jsonapi spec. Once you realized that your
json needed to take on this special form, you went down the path of
creating more structs to be able to serialize and deserialize jsonapi
payloads. Then more models required these additional structure. Ugh!
In comes jsonapi. You can keep your model structs as is and use struct
field tags to indicate to jsonapi how you want your response built or
your request deserialzied. What about my relationships? jsonapi
supports relationships out of the box and will even side load them in
your response into an "included" array--that contains associated
objects.