@leapdev/gui-icons 3.0.1 → 3.0.2

package/README.md

@@ -10,3 +10,27 @@ This is source scss of LEAP GUI Icons Toolkit.
 2. Install Project Dependencies `npm install`
 3. Run `npm link` in Terminal to symlink the project folder. For more Info, visit [npm-link](https://docs.npmjs.com/cli/link)
 4. Run `npm run build` in Terminal to compile GUI
+
+## Usage
+
+### Installing
+
+```bash
+npm install @leapdev/gui-leap-icons
+```
+
+### Basic Usage
+
+
+After installing the package, you can include the icons in your application.
+
+Using sprite files:
+
+```bash
+import '@leapdev/gui-leap-icons/dist/icons/sprite-doctype.svg';
+<svg class="icon icon-lg"><use xlink:href="#icon-id"></use></svg>
+```
+
+As regular .SVGs
+
+import { doctypeAudio24, filledUser24 } from '@leapdev/gui-leap-icons';