Skip to content

Commit

Permalink
Merge pull request #25 from avmaisak/readme-pkg-fix
Browse files Browse the repository at this point in the history
Readme pkg fix
  • Loading branch information
avmaisak authored Aug 16, 2020
2 parents a4ad6bb + 1927039 commit 8e805fc
Show file tree
Hide file tree
Showing 5 changed files with 74 additions and 126 deletions.
159 changes: 38 additions & 121 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

3 changes: 3 additions & 0 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,12 @@
"start": "ng serve --open",
"gen": "node tools/generate-icons.js",
"build": "ng build --prod",
"build-gp": "ng build --prod --base-href https://avmaisak.github.io/ngx-bootstrap-icons/",
"deploy-gp": "ngh --dir dist/ngx-bootstrap-icons",
"build-lib": "npm run gen && ng-packagr -p projects/ngx-bootstrap-icons-lib/ng-package.json",
"test": "ng test",
"lint": "ng lint",
"postinstall": "ngcc",
"e2e": "ng e2e"
},
"private": true,
Expand Down
35 changes: 31 additions & 4 deletions projects/ngx-bootstrap-icons-lib/README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,29 @@
# ngx-bootstrap-icons
<p align="center" style="text-align:center">
<a href="https://getbootstrap.com/">
<img src="https://getbootstrap.com/docs/4.3/assets/brand/bootstrap-solid.svg" alt="Bootstrap logo" width="72" height="72">
</a>

<h3 align="center">ngx-bootstrap-icons</h3>

<span align="center">This package allows you to use the
<a align="center" href="https://icons.getbootstrap.com/">Bootstrap Icons</a> in your angular applications.</span>
</p>

[![GitHub issues](https://img.shields.io/github/issues/avmaisak/ngx-bootstrap-icons)](https://github.com/avmaisak/ngx-bootstrap-icons/issues)
[![GitHub license](https://img.shields.io/github/license/avmaisak/ngx-bootstrap-icons)](https://github.com/avmaisak/ngx-bootstrap-icons/blob/master/LICENSE)
[![GitHub stars](https://img.shields.io/github/stars/avmaisak/ngx-bootstrap-icons)](https://github.com/avmaisak/ngx-bootstrap-icons/stargazers)
[![npm version](https://badge.fury.io/js/ngx-bootstrap-icons.svg)](https://badge.fury.io/js/ngx-bootstrap-icons)

[![Package Quality](https://npm.packagequality.com/badge/ngx-bootstrap-icons.png)](https://packagequality.com/#?package=ngx-bootstrap-icons)



![Bootstrap Icons full set](https://user-images.githubusercontent.com/98681/85891337-be640680-b7a3-11ea-84a0-0a103fce118c.png)

### Description
This package allows you to use the [Bootstrap Icons](https://icons.getbootstrap.com/) in your angular applications.

### Demo
Coming soon

<a href="https://avmaisak.github.io/ngx-bootstrap-icons/" align="center"><strong>Demo Here</strong></a>

### Usage

Expand Down Expand Up @@ -92,3 +111,11 @@ _5. Use it in template_
```ts
<i-bs name="alarm-fill"></i-bs>
```
Also you can use width and height for icon (By default width and height are 1rem)
```ts
<i-bs
name="alarm-fill"
width="2rem"
height="2rem">
</i-bs>
```
2 changes: 1 addition & 1 deletion projects/ngx-bootstrap-icons-lib/package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "ngx-bootstrap-icons",
"version": "0.0.22",
"version": "0.0.23",
"description": "Bootstrap Icons components library for your Angular Applications",
"homepage": "https://avmaisak.github.io/ngx-bootstrap-icons/",
"repository": {
Expand Down
1 change: 1 addition & 0 deletions tsconfig.json
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@
}
},
"angularCompilerOptions": {
"enableIvy": true,
"fullTemplateTypeCheck": true,
"strictInjectionParameters": true,
"disableTypeScriptVersionCheck": true
Expand Down

0 comments on commit 8e805fc

Please sign in to comment.