diff --git a/README.md b/README.md index 7e1dece..2dd278b 100644 --- a/README.md +++ b/README.md @@ -1,14 +1,16 @@ # @angulogic/ng-sidebar -[![npm version](https://img.shields.io/npm/v/@angulogic/ng-sidebar.svg)](https://www.npmjs.com/package/@angulogic/ng-sidebar) +[![npm version](https://img.shields.io/npm/v/@angulogic/ng-sidebar.svg)](https://www.npmjs.com/package/@angulogic/ng-sidebar) [![License](https://img.shields.io/github/license/skarahan35/angulogic.svg)](https://github.com/skarahan35/angulogic/blob/dev/LICENSE) - +![Angular Version](https://img.shields.io/badge/Angular-%3E%3D15.0.0-red.svg) @angulogic/ng-sidebar is a dynamic, interactive, and highly configurable Angular sidebar component designed to provide a rich navigation experience in your Angular applications. It supports nested menus, search functionality, favorites management, theme toggling, responsive view modes, and resizable/auto-position capabilities. --- -![Light Theme](projects/ng-sidebar/assets/images/light.png) ![Dark Theme](projects/ng-sidebar/assets/images/dark.png) +![Light Theme](https://raw.githubusercontent.com/skarahan35/angulogic/refs/heads/dev/projects/ng-sidebar/assets/images/light.png) ![Dark Theme](https://raw.githubusercontent.com/skarahan35/angulogic/refs/heads/dev/projects/ng-sidebar/assets/images/dark.png) + +--- ## Table of Contents @@ -54,6 +56,7 @@ --- + ## Installation Install @angulogic/ng-sidebar via npm: @@ -62,6 +65,20 @@ Install @angulogic/ng-sidebar via npm: npm install @angulogic/ng-sidebar ``` +## Setup + +You can add it to your angular.json for icons and fonts + +```json +"assets": [ + { + "glob": "*/", + "input": "./node_modules/@angulogic/ng-sidebar/assets", + "output": "/assets/" + } +], +``` + --- ## Usage diff --git a/projects/ng-sidebar/README.md b/projects/ng-sidebar/README.md index c362505..6a9910b 100644 --- a/projects/ng-sidebar/README.md +++ b/projects/ng-sidebar/README.md @@ -8,7 +8,7 @@ --- -![Light Theme](assets/images/light.png) ![Dark Theme](assets/images/dark.png) +![Light Theme](https://raw.githubusercontent.com/skarahan35/angulogic/refs/heads/dev/projects/ng-sidebar/assets/images/light.png) ![Dark Theme](https://raw.githubusercontent.com/skarahan35/angulogic/refs/heads/dev/projects/ng-sidebar/assets/images/dark.png) --- @@ -71,9 +71,9 @@ You can add it to your angular.json for icons and fonts ```json "assets": [ - { + { "glob": "*/", - "input": "./node_modules/ng-sidebar/assets", + "input": "./node_modules/@angulogic/ng-sidebar/assets", "output": "/assets/" } ], diff --git a/projects/ng-sidebar/package.json b/projects/ng-sidebar/package.json index 80f82a4..7918d78 100644 --- a/projects/ng-sidebar/package.json +++ b/projects/ng-sidebar/package.json @@ -1,6 +1,6 @@ { "name": "@angulogic/ng-sidebar", - "version": "1.0.0", + "version": "1.0.1", "peerDependencies": { "@angular/common": ">=15.0.0", "@angular/core": ">=15.0.0" @@ -18,5 +18,15 @@ "url": "https://github.com/skarahan35/angulogic/issues" }, "homepage": "https://github.com/skarahan35/angulogic#readme", - "license": "MIT" + "license": "MIT", + "keywords": [ + "angular", + "sidebar", + "navigation", + "responsive", + "sidenav", + "menu", + "angular-sidebar", + "angulogic" + ] }