fix: edit Readme

README.md

@@ -2,29 +2,45 @@
 
 ![Travis (.org)](https://img.shields.io/travis/ThibaudAv/ngx-raptorize)
 ![npm](https://img.shields.io/npm/v/ngx-raptorize)
+[![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release)
 
-This project was generated with [Angular CLI](https://github.com/angular/angular-cli) version 8.3.10.
+Angular2+ representation of the Raptorize plugin like :
 
-## Development server
+- http://zurb.com/playground/jquery-raptorize
+- https://github.com/WyattNielsen/ngRaptorize
 
-Run `ng serve` for a dev server. Navigate to `http://localhost:4200/`. The app will automatically reload if you change any of the source files.
+The goal is a small old scool easter eggs 🥚. And for me to make a small public angular lib 😉
 
-## Code scaffolding
+## Install
 
-Run `ng generate component component-name` to generate a new component. You can also use `ng generate directive|pipe|service|class|guard|interface|enum|module`.
+`yarn add ngx-raptorize`
 
-## Build
+No dependencies (besides Angular2+) are required.
 
-Run `ng build` to build the project. The build artifacts will be stored in the `dist/` directory. Use the `--prod` flag for a production build.
+## Use
 
-## Running unit tests
+Add `<ngx-raptorize></ngx-raptorize>` in your main app component or elsewhere.
+Import module
 
-Run `ng test` to execute the unit tests via [Karma](https://karma-runner.github.io).
+```
+import { NgxRaptorizeModule } from 'ngx-raptorize';
 
-## Running end-to-end tests
+...
 
-Run `ng e2e` to execute the end-to-end tests via [Protractor](http://www.protractortest.org/).
+@NgModule({
+  imports: [
+    ...
+    NgxRaptorizeModule,
+    ...
+  ],
+  bootstrap: [AppComponent],
+  declarations: [AppComponent],
+})
+export class AppModule {}
+```
 
-## Further help
+## Development server
 
-To get more help on the Angular CLI use `ng help` or go check out the [Angular CLI README](https://github.com/angular/angular-cli/blob/master/README.md).
+This project was generated with [Angular CLI](https://github.com/angular/angular-cli)
+
+Run `ng serve` for a dev server. Navigate to `http://localhost:4200/`. The app will automatically reload if you change any of the source files.