Skip to content

Commit

Permalink
docs(project): Updating CHANGELOG.md for v1.0.1
Browse files Browse the repository at this point in the history
  • Loading branch information
AnthonyNahas committed Jul 6, 2022
1 parent 893ebc6 commit 786d7e1
Show file tree
Hide file tree
Showing 4 changed files with 32 additions and 20 deletions.
2 changes: 2 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
## [1.0.1](https://github.com/angular-material-extensions/input-counter/compare/1.0.0...1.0.1) (2022-07-06)

# [1.0.0](https://github.com/angular-material-extensions/input-counter/compare/0.1.1...1.0.0) (2022-07-06)


Expand Down
22 changes: 22 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
The MIT License (MIT)

Copyright (c) 2022 Anthony Nahas

Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including
without limitation the rights to use, copy, modify, merge, publish,
distribute, sublicense, and/or sell copies of the Software, and to
permit persons to whom the Software is furnished to do so, subject to
the following conditions:

The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
24 changes: 6 additions & 18 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,6 @@
[![Coverage Status](https://coveralls.io/repos/github/angular-material-extensions/input-counter/badge.svg?branch=master)](https://coveralls.io/github/angular-material-extensions/input-counter?branch=master)
[![Build Status](https://travis-ci.org/angular-material-extensions/input-counter.svg?branch=master)](https://travis-ci.org/angular-material-extensions/input-counter)
[![CircleCI branch](https://img.shields.io/circleci/project/github/angular-material-extensions/input-counter/master.svg?label=circleci)](https://circleci.com/gh/angular-material-extensions/input-counter)
[![dependency Status](https://david-dm.org/angular-material-extensions/input-counter/status.svg)](https://david-dm.org/angular-material-extensions/input-counter)
[![devDependency Status](https://david-dm.org/angular-material-extensions/input-counter/dev-status.svg?branch=master)](https://david-dm.org/angular-material-extensions/input-counter#info=devDependencies)
[![Greenkeeper Badge](https://badges.greenkeeper.io/angular-material-extensions/input-counter.svg)](https://greenkeeper.io/)
[![license](https://img.shields.io/github/license/angular-material-extensions/input-counter.svg?style=flat-square)](https://github.com/angular-material-extensions/input-counter/blob/master/LICENSE)
[![Awesome](https://cdn.rawgit.com/sindresorhus/awesome/d7305f38d29fed78fa85652e3a63e154dd8e8829/media/badge.svg)](https://github.com/gdi2290/awesome-angular)
Expand Down Expand Up @@ -54,24 +52,14 @@ View all the directives and components in action at [https://angular-material-ex
<a name="dependencies"/>

## Dependencies
* [Angular](https://angular.io) (*requires* Angular 2 or higher | we are using already V9 ;)
* [Angular](https://angular.io) (*requires* Angular


<a name="installation"/>

## [Installation](https://angular-material-extensions.github.io/input-counter/getting-started)

## 1. Install via *ng add*. (Recommended)

If Angular Material Design is not setup, just run `ng add @angular/material` [learn more](https://material.angular.io/guide/getting-started)

Now add the library via the `angular schematics` and everything will be setup for you
```shell
ng add @angular-material-extensions/input-counter
```


## 2. Install via *npm*. (Alternative)
## 1. Install via *npm*.

Now install `@angular-material-extensions/input-counter` via:
```shell
Expand All @@ -83,10 +71,10 @@ npm install --save @angular-material-extensions/input-counter
### Requirements (peer dependencies):

for the ui input component, please consider to install the following packages
- [angular animations v9.x](https://www.npmjs.com/package/@angular/animations)
- [angular forms v9.x](https://www.npmjs.com/package/@angular/forms)
- [angular material v9.x](https://www.npmjs.com/package/@angular/material)
- [angular cdk v9.x](https://www.npmjs.com/package/@angular/cdk)
- [angular animations v14.x](https://www.npmjs.com/package/@angular/animations)
- [angular forms v14.x](https://www.npmjs.com/package/@angular/forms)
- [angular material v14.x](https://www.npmjs.com/package/@angular/material)
- [angular cdk v14.x](https://www.npmjs.com/package/@angular/cdk)

```bash
npm i @angular/cdk @angular/material @angular/animations @angular/forms
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "@angular-material-extensions/input-counter",
"description": "Modern number input component built with angular and material design",
"version": "1.0.0",
"version": "1.0.1",
"homepage": "https://angular-material-extensions.github.io/input-counter",
"author": {
"name": "Anthony Nahas",
Expand Down Expand Up @@ -37,7 +37,7 @@
"release:patch": "../../../node_modules/.bin/release-it --patch --ci",
"release:minor": "../../../node_modules/.bin/release-it --minor --ci",
"release:major": "../../../node_modules/.bin/release-it --major --ci --no-git.requireCleanWorkingDir --dry-run",
"release:custom": "../../../node_modules/.bin/release-it 1.0.0 --ci --no-git.requireCleanWorkingDir",
"release:custom": "../../../node_modules/.bin/release-it 1.0.1 --ci --no-git.requireCleanWorkingDir",
"ng:test": "../../../node_modules/.bin/ng test @angular-material-extensions/input-counter",
"test": "../../../node_modules/.bin/jest --coverage",
"test:watch": "../../../node_modules/.bin/jest --coverage --watch"
Expand Down

0 comments on commit 786d7e1

Please sign in to comment.