@mozaic-ds/vue 1.0.0-rc.0 → 1.0.0-rc.1

package/README.md

@@ -4,7 +4,7 @@
 
 ## Introduction
 
-**MozaicVue** is the [Vue.js](https://vuejs.org/) implementation of [Mozaic Design System](https://mozaic.adeo.cloud/)
+**Mozaic-Vue** is the [Vue.js](https://vuejs.org/) implementation of [Mozaic Design System](https://mozaic.adeo.cloud/)
 
 Note that this package is built to be used with **Vue.js version 2**.
 
@@ -14,7 +14,7 @@ You can have an overview of each component of this library by visiting the dedic
 
 > PREREQUISITE: To allow you to include and use our package in your library, we assume that you are using a module bundlers like [Webpack](https://webpack.js.org/), [Parcel](https://parceljs.org/) or [rollup.js](https://rollupjs.org/guide/en/), or that your project has been initiated with [Vue CLI](https://cli.vuejs.org/). Otherwise, the package might not work.
 
-In order to use **MozaicVue** in your **Vue.js** project, you must first install the npm package:
+In order to use **Mozaic-Vue** in your **Vue.js** project, you must first install the npm package:
 
 ```shell
 $ npm install @mozaic-ds/vue --save --save-exact
@@ -28,7 +28,7 @@ $ yarn add @mozaic-ds/vue -E
 
 ## Usage
 
-**MozaicVue** is a component library that responds to the different usage contexts proposed by **Vue.js**.
+**Mozaic-Vue** is a component library that responds to the different usage contexts proposed by **Vue.js**.
 
 Indeed, as indicated in [its documentation](https://vuejs.org/v2/guide/components-registration.html#Global-Registration), **Vue.js** proposes to register/use the components in a global or local way:
 
@@ -41,7 +41,7 @@ Indeed, as indicated in [its documentation](https://vuejs.org/v2/guide/component
 
 #### Import all components
 
-The easiest way to start using **MozaicVue**, is to import all the components and make them available throughout your application.
+The easiest way to start using **Mozaic-Vue**, is to import all the components and make them available throughout your application.
 
 To do this, in your entry point file, insert the following code:
 
@@ -49,11 +49,13 @@ To do this, in your entry point file, insert the following code:
 // In the entry point file of your application - usually src/main.js
 
 import MozaicVue from '@mozaic-ds/vue';
-import '@mozaic-ds/vue/dist/mozaic-vue.css'; // Import the css of all components (158ko)
+import '@mozaic-ds/vue/dist/mozaic-vue.css'; // Import the css of all components
 
 Vue.use(MozaicVue);
 ```
 
+> NOTE: If you are working on a project that requires the use of the ADEO theme, you should use the following style sheet: `import '@mozaic-ds/vue/dist/mozaic-vue.adeo.css';`
+
 #### Import only the desired components
 
 If you do not want to use all the components of the library, but only some of them, you can proceed as follows:
@@ -62,7 +64,7 @@ If you do not want to use all the components of the library, but only some of th
 // In the entry point file of your application - usually src/main.js
 
 import { MAccordion, MButton } from '@mozaic-ds/vue';
-import '@mozaic-ds/vue/dist/mozaic-vue.css'; // Import the css of all components (158ko)
+import '@mozaic-ds/vue/dist/mozaic-vue.css'; // Import the css of all components
 
 Vue.use(MAccordion);
 Vue.use(MButton);
@@ -77,7 +79,7 @@ That's it! You are now able to use the **Mozaic** components in your **Vue.js**
 Simply call the component of your choice at the desired location anywhere in your application:
 
 ```html
-<m-button label="Default button" />
+<MButton label="Default button" />
 ```
 
 ### Local import
@@ -119,5 +121,5 @@ That's it! You are now able to use the **Mozaic** components in your **Vue.js**
 Simply call the component as follows:
 
 ```html
-<m-button label="Default button" />
+<MButton label="Default button" />
 ```