Skip to content

Commit 61e053f

Browse files
authored
Merge pull request #34 from skarahan35/skarahan
fix: update readme file
2 parents fbc1da0 + 8032461 commit 61e053f

File tree

3 files changed

+35
-8
lines changed

3 files changed

+35
-8
lines changed

README.md

Lines changed: 20 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,16 @@
11
# @angulogic/ng-sidebar
22

3-
[![npm version](https://img.shields.io/npm/v/@angulogic/ng-sidebar.svg)](https://www.npmjs.com/package/@angulogic/ng-sidebar)
3+
[![npm version](https://img.shields.io/npm/v/@angulogic/ng-sidebar.svg)](https://www.npmjs.com/package/@angulogic/ng-sidebar)
44
[![License](https://img.shields.io/github/license/skarahan35/angulogic.svg)](https://github.com/skarahan35/angulogic/blob/dev/LICENSE)
5-
5+
![Angular Version](https://img.shields.io/badge/Angular-%3E%3D15.0.0-red.svg)
66

77
@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.
88

99
---
1010

11-
![Light Theme](projects/ng-sidebar/assets/images/light.png) ![Dark Theme](projects/ng-sidebar/assets/images/dark.png)
11+
![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)
12+
13+
---
1214

1315
## Table of Contents
1416

@@ -54,6 +56,7 @@
5456

5557
---
5658

59+
5760
## Installation
5861

5962
Install @angulogic/ng-sidebar via npm:
@@ -62,6 +65,20 @@ Install @angulogic/ng-sidebar via npm:
6265
npm install @angulogic/ng-sidebar
6366
```
6467

68+
## Setup
69+
70+
You can add it to your angular.json for icons and fonts
71+
72+
```json
73+
"assets": [
74+
{
75+
"glob": "*/",
76+
"input": "./node_modules/@angulogic/ng-sidebar/assets",
77+
"output": "/assets/"
78+
}
79+
],
80+
```
81+
6582
---
6683

6784
## Usage

projects/ng-sidebar/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88

99
---
1010

11-
![Light Theme](assets/images/light.png) ![Dark Theme](assets/images/dark.png)
11+
![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)
1212

1313
---
1414

@@ -71,9 +71,9 @@ You can add it to your angular.json for icons and fonts
7171

7272
```json
7373
"assets": [
74-
{
74+
{
7575
"glob": "*/",
76-
"input": "./node_modules/ng-sidebar/assets",
76+
"input": "./node_modules/@angulogic/ng-sidebar/assets",
7777
"output": "/assets/"
7878
}
7979
],

projects/ng-sidebar/package.json

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "@angulogic/ng-sidebar",
3-
"version": "1.0.0",
3+
"version": "1.0.1",
44
"peerDependencies": {
55
"@angular/common": ">=15.0.0",
66
"@angular/core": ">=15.0.0"
@@ -18,5 +18,15 @@
1818
"url": "https://github.com/skarahan35/angulogic/issues"
1919
},
2020
"homepage": "https://github.com/skarahan35/angulogic#readme",
21-
"license": "MIT"
21+
"license": "MIT",
22+
"keywords": [
23+
"angular",
24+
"sidebar",
25+
"navigation",
26+
"responsive",
27+
"sidenav",
28+
"menu",
29+
"angular-sidebar",
30+
"angulogic"
31+
]
2232
}

0 commit comments

Comments
 (0)