Commit Graph

65 Commits

Author SHA1 Message Date
Santiago Pastorino
cf8145230e Merge pull request #413 from strzalek/reorder-readme
Changes to README
2013-10-22 05:05:09 -07:00
Łukasz Strzałkowski
3f4ab36e7e Add AMS heading 2013-10-22 09:53:42 +00:00
Łukasz Strzałkowski
e531df3b4e Move design section to the top 2013-10-22 09:53:33 +00:00
Santiago Pastorino
8f583d2c46 Merge pull request #337 from lserman/update-meta-key-docs
Updating documentation to warn users that { root: false } will ignore the meta key
2013-10-21 13:12:28 -07:00
Santiago Pastorino
594eaa1576 Use scope in docs instead of current_user
Closes #322
2013-10-21 17:56:03 -02:00
Santiago Pastorino
477a0ae1d2 Add back README.md file 2013-10-18 17:49:22 -02:00
Santiago Pastorino
14f51f2ea9 Remove everything, rewrite of AMS starts here 2013-10-18 17:46:18 -02:00
mikegee
23748e7f2b add Design and Implementation section to readme
credit to @garysweaver
2013-08-29 16:04:20 -04:00
stiller
a62680c883 Update README.md
Fixed typo.
2013-07-04 11:32:25 +02:00
T.J. Schuck
027aa38138 Add docs about caching 2013-06-26 16:48:36 -04:00
Andre Meij
54ce37b956 Change to 1.9 Hash syntax in docs 2013-06-18 16:40:14 +02:00
Andre Meij
88ff42ebc8 Use 1.9 hashes in the readme 2013-06-18 16:35:03 +02:00
Logan Serman
b20ad33407 Updating the meta key documentation to warn users that { root: false } will cause the serializer to ignore the meta key as it leads to invalid JSON.
https://github.com/rails-api/active_model_serializers/issues/332
2013-06-16 01:01:03 -05:00
Jamie Gaskins
74af00f17a Remove errant apostrophes
Apostrophes don't indicate pluralization.
2013-06-08 12:18:34 -03:00
Anson Hoyt
173f3f2a17 Explain how to include an attribute named "object" 2013-06-06 14:41:45 -04:00
Tee Parham
d10b5f6ac0 add ruby 1.8 install note [ci skip]
fixes #310
2013-05-30 15:25:06 -06:00
David Verhasselt
2cc598c74a Update README.md
Setting AMS::Serializer.root = false doesn't automatically disable root for the ArraySerializer.
2013-05-21 12:00:39 +03:00
David Verhasselt
1614ef3b12 Create new section 'Disabling root' in README 2013-05-14 11:30:22 +03:00
David Verhasselt
358b6a8875 Update README.md 2013-05-14 10:42:28 +03:00
David Verhasselt
5504293776 Update README.md
I'm a bit embarrassed to admit that it took me a while to figure out this was a possibility, so I figured maybe this change will save some other poor chaps their time and/or pride.
2013-05-13 18:23:20 +03:00
vanstee
6b6afb8a83 Bump minor version specified in Gemfile 2013-05-11 02:33:27 -04:00
Steve Klabnik
48e5ca29f1 Add Coveralls for code coverage. 2013-05-05 13:38:56 -07:00
Steve Klabnik
a0b07259ae Add CodeClimate badge. 2013-05-05 13:04:39 -07:00
Gosha Arinich
1482081766 add support of mongoid collection serialization 2013-05-05 21:50:34 +03:00
Silvio Relli
9ca71c2443 Update README.md
Fixed typo in documentation about the number of options to disable the root element for arrays
2013-05-02 16:27:06 +03:00
Tee Parham
6b0ceba148 fix travis links
The existing links work, but redirect.
2013-04-24 21:55:50 -06:00
Steve Klabnik
049cff57c2 Merge pull request #250 from gabetax/documentation/belongs_to
Document inclusion of belongs_to ActiveRecord associations
2013-03-23 05:43:28 -07:00
Gabe Martin-Dempesy
01d1228772 Document inclusion of belongs_to ActiveRecord associations 2013-03-23 00:48:00 -05:00
Michael Kaiser-Nyman
1fc314786e fix grammar in readme 2013-03-22 15:19:13 -07:00
beerlington
4a13f86961 Reference scope by same name as serialization scope
By default, the serialization scope uses current_user, and you can
now reference the scope as "current_user" in the serializer. If you
override the scope using "serialization_scope" in your controller,
it will use that method name instead.
2013-03-18 14:44:38 -04:00
Attila Domokos
5f9209e619 Fixing README.md 2013-03-13 20:53:20 -04:00
Paul McMahon
87509e9537 More clearly recommend to add to Gemfile 2013-03-10 17:48:34 +09:00
Steve Klabnik
e76a16486f Merge pull request #170 from FundingGates/master
Support optional types for computed attributes
2013-03-08 09:11:29 -08:00
Miloš Hadžić
befac17160 Update release version in README. 2013-03-06 17:40:41 +01:00
Jeremy Redburn
7cd7d295e0 Adding 'embed_key' option to allow embedding attributes other than ID 2013-03-05 18:52:31 -05:00
Steve Klabnik
585b1bc508 No longer recommend installation from git 2013-03-05 15:28:56 -08:00
Steve Klabnik
49cca10592 Merge pull request #172 from vladson/patch-1
Added description of default_serializer_options to README.md. Fixes #168
2013-03-05 14:46:06 -08:00
Paulo H. C. de Oliveira
e322f903cf Update README.md file to better describe scope.
This commit also corrects the code about deactivating globally the root name of arrays.
2013-03-05 13:37:11 -03:00
Kir Shatrov
dd989043e3 Gemfile improvement in README 2013-02-09 23:04:25 +02:00
Steve Klabnik
cef10cf01d Revert "Merge pull request #186 from gerfuls/master"
This reverts commit d030cd99cf, reversing
changes made to a1d5561eac.
2013-01-15 11:51:42 -05:00
Joshua Dover
016412b3d7 Fixed README typo 2013-01-12 19:18:08 -06:00
Steve Klabnik
a1d5561eac Merge pull request #185 from kevins90/update_readme_object_accessor
Revised one more instance in the doc referring to the object method alias
2013-01-11 10:10:05 -08:00
Kevin Tham
3cd953ffa8 Revised one more instance in the doc referring to the method alias to access the object being serialized 2013-01-11 10:01:37 -08:00
Enio Lopes
97e7ec1d32 Uses colon on :meta_key 2013-01-11 11:22:45 -02:00
Enio Lopes
244021d65c Corrects some markdown properties, identation and text 2013-01-11 11:06:26 -02:00
Enio Lopes
0994f3dda8 Adds documentation for usage of meta and meta_key options 2013-01-11 00:18:53 -02:00
Steve Klabnik
e4d244f865 Merge pull request #183 from kevins90/update_readme_associations
Update association section on README.md
2013-01-10 10:51:05 -08:00
Kevin Tham
1b6ccbbe7b Update association section on README.md to reflect deprecation of the prefix of the serializer class being used as the accessor to the object we wish to serialize. (reason was previously that the name of the object being serialized is not necessarily going to be the prefix of the serializer class and worse the prefix could have been an attribute of the object itself) 2013-01-10 10:02:38 -08:00
Vladislav
ccc9c2c696 Update README.md
Spelling and murkup mistakes fixed.
2013-01-06 13:31:35 +04:00
Dan Gebhardt
3b1d2faf51 Append an _id or _ids suffix to associations' keys. Embed objects in root according to their serializers' names.
An `_id` suffix will be appended to the name of HasOne associations, while `_ids` will be appended to the singularized name of HasMany associations. Association keys can still be overridden with the `key` option.

Furthermore, objects embedded in the root are now by default named according to their serializer, instead of the key used for their associations.
2012-12-21 15:14:50 -05:00