diff --git a/DOCUMENTATION.md b/DOCUMENTATION.md deleted file mode 120000 index 79f7754..0000000 --- a/DOCUMENTATION.md +++ /dev/null @@ -1 +0,0 @@ -docs_src/documentation.md \ No newline at end of file diff --git a/DOCUMENTATION.md b/DOCUMENTATION.md new file mode 100644 index 0000000..c4877b9 --- /dev/null +++ b/DOCUMENTATION.md @@ -0,0 +1,328 @@ +## Setup + +### Installation + +Barbiche is available as a [npm](https://www.npmjs.com/) package: + +`npm install barbiche` + +### Polyfills + +For decent browser support, using some polyfills is required. Good results can be obtained with: +* [DOM4](https://github.com/WebReflection/dom4) (available as npm package dom4) +* [template](https://github.com/webcomponents/template) (no npm package, using commit #47b57a is currently recommended) + +Those polyfills are included in Barbiche package in `polyfills.min.js`. + +## Barbiche API +### Common usage +First, we create a Barbiche instance: +```js +var barbiche = Barbiche(); +``` +Now, `barbiche` is a factory function that expects the id string of a `