docs(): some refactoring

Author: iobaixas

docs/guides/integration.md

@@ -20,7 +20,7 @@ The primary key is just a model configuration property and by default is set to
 To change it for a particular model use the configuration property:
 
 ```javascript
-restmod.model('/bikes', {
+restmod.model('/bikes').$mix({
 	PRIMARY_KEY: '_id'
 });
 ```
@@ -81,10 +81,10 @@ Will expect:
 }
 ```
 
-The resoure's name is extracted from the resource url, if no url is given (anonymous resource) or if url does not match the resource's name, then you can change it's name and plural name by setting the `NAME` and `PLURAL` configuration variables:
+The resoure's name is extracted from the resource url, if no url is given (nested resource) or if url does not match the resource's name, then you can change it's name and plural name by setting the `NAME` and `PLURAL` configuration variables:
 
 ```javascript
-restmod.model(null, function() {
+restmod.model().$mix(function() {
 	NAME: 'mouse', // if you only set NAME, then plural is infered from it using the inflector.
 	PLURAL: 'mice'
 });
@@ -128,7 +128,7 @@ To change the property from where the packer extracts the metadata set the `JSON
 ```
 
 ```javascript
-var Bike = restmod.model('/api/bikes', {
+var Bike = restmod.model('/api/bikes').$mix({
 	PACKER: 'default',
 	JSON_META: '.'
 });
@@ -176,10 +176,10 @@ var Base = restmod.mixin({
 	PACKER: 'default' // remember to enable the default packer.
 });
 
-var User = restmod.model('/api/users', Base);
-var Part = restmod.model('/api/parts', Base);
+var User = restmod.model('/api/users').$mix(Base);
+var Part = restmod.model('/api/parts').$mix(Base);
 
-var Bike = restmod.model('/api/bikes', Base, {
+var Bike = restmod.model('/api/bikes').$mix(Base, {
 	user: { belongsTo: User },
 	parts: { belongsToMany: Part }
 })
@@ -203,7 +203,7 @@ module.config(function(restmodProvider) {
 Take a look at the default naming stardards, inlined resources are expected to use the **pluralized** names for their respective model names. See. By default the name is extracted from the url, you can change a model's name and plural name by setting the `NAME` and `PLURAL` configuration variables:
 
 ```javascript
-restmod.model(null, function() {
+restmod.model().$mix(function() {
 	NAME: 'mouse', // if you only set NAME, then plural is infered from it.
 	PLURAL: 'mice'
 });
@@ -256,7 +256,7 @@ To handle API's that require '$' prefixed properies you have two posibilities:
 2. if there are only a couple of properties you need to let through, assign a special mapping to those properties:
 
 	```javascript
-	restmod.model(null {
+	restmod.model().$mix({
 		myType: { map: '$type' },
 		myName: { map: '$name' }
 	})
@@ -329,6 +329,6 @@ module.config(function(restmodProvider) {
 });
 ```
 
-To see available styles checkout the [Style listing](https://github.com/platanus/angular-restmod/blob/master/docs/guides/styles.md).
+To see available styles or colaborate with a new one, take a look at the [Style listing](https://github.com/platanus/angular-restmod/blob/master/docs/guides/styles.md).
 
 

docs/guides/styles.md

@@ -7,10 +7,6 @@ the undelying backend, so for example, since rails is usually programmed in snak
 the active_model_serializer style will enable the property renaming to convert every
 property to camelcase on arrival.
 
-**Api styles contributions are welcomed!!, some ideas:**
-* django style APIs
-* .NET style APIs
-
 To use a style first make sure style script file is being loaded:
 
 ```html
@@ -44,3 +40,17 @@ Mixin Name: `AMSApi`
 * Json metadata expected in 'meta' property
 * Json links expected in 'links' property
 * Default primary key: id
+
+## Contributions
+
+**Api styles contributions are welcomed!!, some ideas:**
+* django style APIs
+* .NET style APIs
+
+To contribute with a new style just:Pcom
+* Clone restmod repo
+* Create new style mixin file in the `src/styles` dir
+* Add tests for additional components (like packers, renamers, etc)
+* Make sure the build process generates the new style script
+* Add it to this listing, with some reference to where the style is described.
+* PR it!