chore: 1.0.0 release - update README file

woothu · woothu · commit ed4ded549f20 · 2019-12-10T17:10:32.000+01:00
diff --git a/README.md b/README.md
@@ -1,2 +1,21 @@
-# coreui-utils
-CoreUI JavaScript utility functions
+# CoreUI Utilities
+
+CoreUI utility JavaScript functions
+
+## Installation
+
+```shell
+npm install @coreui/icons-vue --save
+```
+
+## Usage
+
+ES5 functions from common.js module
+```js
+import { deepObjectsMerge } from '@coreui/utils';
+```
+
+ES6+ functions from source, to enable treeshaking
+```js
+import { deepObjectsMerge } from '@coreui/utils/src';
+```
