Skip to content

Commit

Permalink
Merge pull request #34 from skarahan35/skarahan
Browse files Browse the repository at this point in the history
fix: update readme file
  • Loading branch information
ergulferik authored Feb 4, 2025
2 parents fbc1da0 + 8032461 commit 61e053f
Show file tree
Hide file tree
Showing 3 changed files with 35 additions and 8 deletions.
23 changes: 20 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -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

Expand Down Expand Up @@ -54,6 +56,7 @@

---


## Installation

Install @angulogic/ng-sidebar via npm:
Expand All @@ -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
Expand Down
6 changes: 3 additions & 3 deletions projects/ng-sidebar/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)

---

Expand Down Expand Up @@ -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/"
}
],
Expand Down
14 changes: 12 additions & 2 deletions projects/ng-sidebar/package.json
Original file line number Diff line number Diff line change
@@ -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"
Expand All @@ -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"
]
}

0 comments on commit 61e053f

Please sign in to comment.