Merge branch 'master' of https://github.com/geeklearningio/gl-angular-configuration

mvidailhet · mvidailhet · commit 3025d53b1282 · 2016-08-29T15:41:08.000+02:00
diff --git a/README.md b/README.md
@@ -1,10 +1,76 @@
+# Introduction
+This is a confuguration package for Angular. 
+It allows you to dynamically load a json file at the root of your project.
+It also provides a provider that allows you to add configuration values in the config function of your Angular app.
+There is a test app using this Provider to show how to configure and use it.
 
+# Requirements
+- npm
+- angular
 
+# How to configure
+1) In your project folder, install this plugin using npm
+`npm install git+https://git@github.com/geeklearningio/gl-angular-configuration.git --save`
 
+2) You can use the Typescript (`package/src/ConfigurationProvider.ts`) or the Javascript ((`package/dist/ConfigurationProvider.js`)) version of the Provider.
 
+3) In your application's main module, inject the dependency `gl-angular-configuration` in order to use the Provider.
+```
+angular.module('mainModuleName', ['ionic', 'gl-angular-configuration']){
 
+}
+```
 
+# How to use
 
+## Dynamically load the configuration.json file (optional)
+Add a `configuration.json` file at the root of your project.
+Remove the automatic bootstrap of your angular app. You can do it by Removing the `ng-app` tag of your `index.html` file.
+It will allow you to boostrap it manually after the json has been loaded.
+```
+<html ng-app="testApp">
+```
 
+In your application's main module, call the `loadConfigurationJSON` and pass a callback as a param. In the callback, get the html dom element and bootstrap manually your app.
+```
+loadConfigurationJSON(() => {
+    var domElement = document.querySelector('html');
+    angular.bootstrap(domElement, ["testApp"]);
+});
+```
+
+## Add a configuration at config
+In the config function of your Angular application, inject the `ConfigurationProvider` and call the `addObject` function. 
+You can specify the type of your configuration object in the Typescript version.
+
+```
+import {ConfigurationProvider} from "gl-angular-configuration/package/src/ConfigurationProvider";
+
+interface ITestAppConfiguration {
+    env: string
+}
+
+export class Config {
+    constructor(configurationProvider: ConfigurationProvider<ITestAppConfiguration>) {
+        configurationProvider.addObject({otherParam: 'test'});
+    }
+}
+```
+
+## How to use the test app
+the test app does not have the package as a dependency. It allows you to make changes directly to the package and use it in your test app.
+
+You need to link the package locally.
+At the root of the project (containing the `package` and the `test-app` folders) type this in the terminal:
+```
+npm link
+```
+It will add `gl-angular-configuration` as a global npm module.
+
+Then go in the test-app folder and type this:
+```
+npm link gl-angular-configuration
+```
+It will link it to the test-app.
 
 
