Skip to content

Commit

Permalink
Bump to version: v0.2.1
Browse files Browse the repository at this point in the history
  • Loading branch information
Nils Knappmeier committed Jul 14, 2015
1 parent 6edbd9d commit 793c88c
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 12 deletions.
22 changes: 11 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,28 +24,28 @@ npm install customize

## API-reference

# Global
### Global





* * *

### exports()
##### exports()

Create a new Customize object with an empty configuration

**Returns**: `Customize`


## Class: Customize
#### Class: Customize
The main class. The heart of Customize

**withParent**: , The main class. The heart of Customize
**leaf**: , The main class. The heart of Customize
**overrider**: `customOverrider` , The main class. The heart of Customize
### Customize.registerEngine(id, engine)
##### Customize.registerEngine(id, engine)

Register an engine with a default config

Expand All @@ -56,7 +56,7 @@ Register an engine with a default config
**engine**: `function`, Register an engine with a default config


### Customize.merge(config)
##### Customize.merge(config)

Creates a new instance of Customize. The config of the current Customize
are used as default values and are overridden by the config provided as parameter.
Expand All @@ -67,7 +67,7 @@ are used as default values and are overridden by the config provided as paramete

**Returns**: `Customize`, new Builder instance

### Customize.load(builderFunction)
##### Customize.load(builderFunction)

Inherit configuration config from another module.
`require("Customize-modulename")` usually return a function(builder)
Expand All @@ -82,22 +82,22 @@ with config from the builderFunction's result.

**Returns**: `Customize`, the result of the builderFunction

### Customize.build()
##### Customize.build()

Build the configured Bootprint-instance.

**Returns**: `Promise.<object>`, a promise for the whole configuration

### Customize.run()
##### Customize.run()

Run each engine with its part of the config.


### Customize.customOverrider(a, b, propertyName)
##### Customize.customOverrider(a, b, propertyName)

Customize has predefined override rules for merging configs.

* If the overriding object has a `_ro_custom_overrider` function-property,
* If the overriding object has a `_customize_custom_overrider` function-property,
it is called to perform the merger.
* Arrays are concatenated
* Promises are resolved and the results are merged
Expand All @@ -110,7 +110,7 @@ Customize has predefined override rules for merging configs.

**propertyName**: , the property name

**Returns**: `*`
**Returns**: `*`, the merged value



Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "customize",
"version": "0.2.0",
"version": "0.2.1",
"description": "A simple framework to create customizable engines",
"repository": {
"type": "git",
Expand Down

0 comments on commit 793c88c

Please sign in to comment.