Skip to content

Commit d924d19

Browse files
author
Jon Rista
committed
chore: update readmy files
1 parent 13523ba commit d924d19

File tree

2 files changed

+21
-18
lines changed

2 files changed

+21
-18
lines changed

README.md

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -31,10 +31,10 @@ other NgRX application.
3131

3232
What Auto-Entity does do is provide a set of ready-made, generic actions for handling all of
3333
the standard CRUD operations for entities, so you neither have to write nor generate any of that
34-
code yourself. Auto-Entity generates **pre-fabricated facades** around NgRx and the store/state, providing
35-
a cohesive, logical and simplified API into your state. Auto-Entity presents a flexible framework
36-
that you may use in its entirety for all of your entity needs, or use piecemeal as necessary in
37-
order to achieve your specific goals.
34+
code yourself. Auto-Entity generates **pre-fabricated facades** around NgRx and the store/state,
35+
providing a cohesive, logical and simplified API into your state. Auto-Entity presents a flexible
36+
framework that you may use in its entirety for all of your entity needs, or use piecemeal as
37+
necessary in order to achieve your specific goals.
3838

3939
While it is not required and Auto-Entity is an entirely independent library that solely depends
4040
on Angular and NgRX, Auto-Entity manages state in a manner that is compatible with @ngrx/entity
@@ -43,7 +43,7 @@ custom reducers.
4343

4444
# Dependencies
4545

46-
NgRx Auto-Entity currently depends on Angular 8, NgRx 8 and RxJs 6.
46+
NgRx Auto-Entity currently depends on Angular 8+, NgRx 8+ and RxJs 6.
4747

4848

4949
[![Deps-AngularCore](https://img.shields.io/badge/@angular/core-%5E8.x-blue.svg)](https://github.com/angular/angular)
@@ -59,7 +59,7 @@ Install @briebug/ngrx-auto-entity from npm:
5959

6060
If you have not already, install the required peer dependencies as well:
6161

62-
`npm install @ngrx/{effects,store,store-devtools} ngrx-store-freeze` or `yarn add @ngrx/{effects,store,store-devtools} ngrx-store-freeze`
62+
`npm install @ngrx/{effects,store,store-devtools}` or `yarn add @ngrx/{effects,store,store-devtools}`
6363

6464
## Quick Start
6565

@@ -91,6 +91,7 @@ If you wish to learn more about how Auto-Entity works, you may jump to the
9191
- [x] Enhanced IEntityInfo interface with naming utilities
9292
- [x] Filtering of entities effects handle
9393
- [x] Custom transformation of data to and from the server (i.e. ISO date to Date())
94+
- [x] Optional data loading it not already present, with max age
9495
- [ ] Normalization of API with NgRx 8 functional/factory function architecture
9596
- [ ] Extended effects for loading indicator display, toasts or snackbars, etc.
9697
- [ ] Filtering of entities meta reducer handles
@@ -99,14 +100,14 @@ If you wish to learn more about how Auto-Entity works, you may jump to the
99100
# Contributors
100101

101102
[![Follow-BB](https://img.shields.io/twitter/follow/briebugsoftware.svg?style=flat)](https://twitter.com/briebugsoftware)
102-
[![Follow-BB](https://img.shields.io/twitter/follow/JesseS_BrieBug.svg?style=flat)](https://twitter.com/JesseS_BrieBug)
103103
[![Follow-BB](https://img.shields.io/twitter/follow/jonristadev.svg?style=flat)](https://twitter.com/JonRistaDev)
104104
[![Follow-BB](https://img.shields.io/twitter/follow/kevinschuchard.svg?style=flat)](https://twitter.com/kevinschuchard)
105105
[![Follow-BB](https://img.shields.io/twitter/follow/anthonyjones519.svg?style=flat)](https://twitter.com/anthonyjones519)
106106

107107
- [Jesse Sanders](https://github.com/jessesanders): Evil Mastermind!
108108
- [Jon Rista](https://github.com/jrista): Design, Architecture & Implementation
109+
- [Kevin Schuchard](https://github.com/schuchard): Design & Implementation
109110
- [Brian Love](https://github.com/blove): Design & Implementation
110-
- [Alice Paquette](https://github.com/paquettealice): Alice Paquette
111-
- [Patrice Paquette](https://github.com/patpaquette): Patrice Paquette
111+
- [Alice Paquette](https://github.com/paquettealice): Implementation
112+
- [Patrice Paquette](https://github.com/patpaquette): Implementation
112113
- [Anthony Jones](https://github.com/anthonymjones): Implementation

projects/ngrx-auto-entity/README.md

Lines changed: 11 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -31,10 +31,10 @@ other NgRX application.
3131

3232
What Auto-Entity does do is provide a set of ready-made, generic actions for handling all of
3333
the standard CRUD operations for entities, so you neither have to write nor generate any of that
34-
code yourself. Auto-Entity generates **pre-fabricated facades** around NgRx and the store/state, providing
35-
a cohesive, logical and simplified API into your state. Auto-Entity presents a flexible framework
36-
that you may use in its entirety for all of your entity needs, or use piecemeal as necessary in
37-
order to achieve your specific goals.
34+
code yourself. Auto-Entity generates **pre-fabricated facades** around NgRx and the store/state,
35+
providing a cohesive, logical and simplified API into your state. Auto-Entity presents a flexible
36+
framework that you may use in its entirety for all of your entity needs, or use piecemeal as
37+
necessary in order to achieve your specific goals.
3838

3939
While it is not required and Auto-Entity is an entirely independent library that solely depends
4040
on Angular and NgRX, Auto-Entity manages state in a manner that is compatible with @ngrx/entity
@@ -43,7 +43,7 @@ custom reducers.
4343

4444
# Dependencies
4545

46-
NgRx Auto-Entity currently depends on Angular 8, NgRx 8 and RxJs 6.
46+
NgRx Auto-Entity currently depends on Angular 8+, NgRx 8+ and RxJs 6.
4747

4848

4949
[![Deps-AngularCore](https://img.shields.io/badge/@angular/core-%5E8.x-blue.svg)](https://github.com/angular/angular)
@@ -59,7 +59,7 @@ Install @briebug/ngrx-auto-entity from npm:
5959

6060
If you have not already, install the required peer dependencies as well:
6161

62-
`npm install @ngrx/{effects,store,store-devtools} ngrx-store-freeze` or `yarn add @ngrx/{effects,store,store-devtools} ngrx-store-freeze`
62+
`npm install @ngrx/{effects,store,store-devtools}` or `yarn add @ngrx/{effects,store,store-devtools}`
6363

6464
## Quick Start
6565

@@ -91,6 +91,7 @@ If you wish to learn more about how Auto-Entity works, you may jump to the
9191
- [x] Enhanced IEntityInfo interface with naming utilities
9292
- [x] Filtering of entities effects handle
9393
- [x] Custom transformation of data to and from the server (i.e. ISO date to Date())
94+
- [x] Optional data loading it not already present, with max age
9495
- [ ] Normalization of API with NgRx 8 functional/factory function architecture
9596
- [ ] Extended effects for loading indicator display, toasts or snackbars, etc.
9697
- [ ] Filtering of entities meta reducer handles
@@ -99,14 +100,15 @@ If you wish to learn more about how Auto-Entity works, you may jump to the
99100
# Contributors
100101

101102
[![Follow-BB](https://img.shields.io/twitter/follow/briebugsoftware.svg?style=flat)](https://twitter.com/briebugsoftware)
102-
[![Follow-BB](https://img.shields.io/twitter/follow/JesseS_BrieBug.svg?style=flat)](https://twitter.com/JesseS_BrieBug)
103103
[![Follow-BB](https://img.shields.io/twitter/follow/jonristadev.svg?style=flat)](https://twitter.com/JonRistaDev)
104104
[![Follow-BB](https://img.shields.io/twitter/follow/kevinschuchard.svg?style=flat)](https://twitter.com/kevinschuchard)
105105
[![Follow-BB](https://img.shields.io/twitter/follow/anthonyjones519.svg?style=flat)](https://twitter.com/anthonyjones519)
106106

107107
- [Jesse Sanders](https://github.com/jessesanders): Evil Mastermind!
108108
- [Jon Rista](https://github.com/jrista): Design, Architecture & Implementation
109+
- [Kevin Schuchard](https://github.com/schuchard): Design & Implementation
109110
- [Brian Love](https://github.com/blove): Design & Implementation
110-
- [Alice Paquette](https://github.com/paquettealice): Alice Paquette
111-
- [Patrice Paquette](https://github.com/patpaquette): Patrice Paquette
111+
- [Alice Paquette](https://github.com/paquettealice): Implementation
112+
- [Patrice Paquette](https://github.com/patpaquette): Implementation
112113
- [Anthony Jones](https://github.com/anthonymjones): Implementation
114+

0 commit comments

Comments
 (0)