Skip to content

Commit

Permalink
updated ReadME files, tested ngx-mat-typeahead against ivy compilatio…
Browse files Browse the repository at this point in the history
…n(ngcc)
  • Loading branch information
Sanjiv Kumar committed Apr 18, 2020
1 parent e53e46e commit fe7626a
Show file tree
Hide file tree
Showing 8 changed files with 43 additions and 13 deletions.
16 changes: 12 additions & 4 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,21 @@
## NgxMatTypeahead - v1.0.2 (04/18/2020)

### Improvements:

- Library compatible with Ivy.
- Made the Peer depedency of Angular to version 8.
- Updated ReadMe.

## NgxMatTypeahead - v1.0.1 (05/27/2018)

### Improvements:

* Added MIT License.
* Updated README with correct npm installation command for this directive.
* Updated example code under `src/app` to use `ngx-mat-typeahead` module from npm/node_modules.
- Added MIT License.
- Updated README with correct npm installation command for this directive.
- Updated example code under `src/app` to use `ngx-mat-typeahead` module from npm/node_modules.

## NgxMatTypeahead - v1.0.0 (05/27/2018)

### New Features:

* A simple typeahead `directive` to be used with Angular Material input and matAutocomplete component. Go through the `README.md` file for detailed features and documentation.
- A simple typeahead `directive` to be used with Angular Material input and matAutocomplete component. Go through the `README.md` file for detailed features and documentation.
2 changes: 1 addition & 1 deletion LICENSE
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
MIT License

Copyright (c) 2018 Sanjiv Kumar
Copyright (c) 2020 Sanjiv Kumar

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand Down
5 changes: 4 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# NgxMatTypeahead

**Update**: This library is Ivy Compatible and is tested against an Angular 9 app. (check example in angular_v9 branch)

* A simple typeahead `directive` to be used with Angular Material input and matAutocomplete component.
* This directives enhances the funtionality of Angular Material `matAutocomplete` component and is recommended that it is used with it.
* However, this directive can be used with `any other` autocomplete component.
Expand Down Expand Up @@ -120,7 +122,8 @@ export class AppComponent implements OnInit {

* `npm i`
* Run `ng serve` for a dev server and running the demo app. Navigate to `http://localhost:4200/`. The app will automatically reload if you change any of the source files.
* The demo app uses `json-server` module for enabling the url and filter funtionality.
* The demo app uses `json-server` module for enabling the url and filter funtionality. Make sure you have [json-server](https://www.npmjs.com/package/json-server#getting-started) installed and running.
* Once you have installed json-server, Run: `json-server --watch db.json`. You can see it running at `http://localhost:3000`.

## Build the NgxMatTypeahead module

Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "mat-typeahead-library",
"version": "1.0.1",
"version": "1.0.2",
"scripts": {
"ng": "ng",
"start": "ng serve",
Expand Down
18 changes: 17 additions & 1 deletion projects/ngx-mat-typeahead/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,21 @@
## NgxMatTypeahead - v1.0.2 (04/18/2020)

### Improvements:

- Library compatible with Ivy.
- Made the Peer depedency of Angular to version 8.
- Updated ReadMe.

## NgxMatTypeahead - v1.0.1 (05/27/2018)

### Improvements:

- Added MIT License.
- Updated README with correct npm installation command for this directive.
- Updated example code under `src/app` to use `ngx-mat-typeahead` module from npm/node_modules.

## NgxMatTypeahead - v1.0.0 (05/27/2018)

### New Features:

* A simple typeahead `directive` to be used with Angular Material input and matAutocomplete component. Go through the `README.md` file for detailed features and documentation.
- A simple typeahead `directive` to be used with Angular Material input and matAutocomplete component. Go through the `README.md` file for detailed features and documentation.
2 changes: 1 addition & 1 deletion projects/ngx-mat-typeahead/LICENSE
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
MIT License

Copyright (c) 2018 Sanjiv Kumar
Copyright (c) 2020 Sanjiv Kumar

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand Down
5 changes: 4 additions & 1 deletion projects/ngx-mat-typeahead/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# NgxMatTypeahead

**Update**: This library is Ivy Compatible and is tested against an Angular 9 app. (check example in angular_v9 branch)

* A simple typeahead `directive` to be used with Angular Material input and matAutocomplete component.
* This directives enhances the funtionality of Angular Material `matAutocomplete` component and is recommended that it is used with it.
* However, this directive can be used with `any other` autocomplete component.
Expand Down Expand Up @@ -120,7 +122,8 @@ export class AppComponent implements OnInit {

* `npm i`
* Run `ng serve` for a dev server and running the demo app. Navigate to `http://localhost:4200/`. The app will automatically reload if you change any of the source files.
* The demo app uses `json-server` module for enabling the url and filter funtionality.
* The demo app uses `json-server` module for enabling the url and filter funtionality. Make sure you have [json-server](https://www.npmjs.com/package/json-server#getting-started) installed and running.
* Once you have installed json-server, Run: `json-server --watch db.json`. You can see it running at `http://localhost:3000`.

## Build the NgxMatTypeahead module

Expand Down
6 changes: 3 additions & 3 deletions projects/ngx-mat-typeahead/package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "ngx-mat-typeahead",
"version": "1.0.1",
"version": "1.0.2",
"description":"A simple typeahead directive to be used with Angular Material input and matAutocomplete component.",
"author": "Sanjiv Kumar ([email protected])",
"repository": {
Expand All @@ -21,7 +21,7 @@
],
"license": "MIT",
"peerDependencies": {
"@angular/common": "^6.0.0-rc.0 || ^6.0.0",
"@angular/core": "^6.0.0-rc.0 || ^6.0.0"
"@angular/common": "^8.0.0",
"@angular/core": "^8.0.0"
}
}

0 comments on commit fe7626a

Please sign in to comment.