Skip to content

Commit fa9afe6

Browse files
authored
Merge pull request #340 from SwabianCoder/chore/339-improve-readme-of-ngx-toolset-date-interceptors-package
Chore/339 improve readme of ngx toolset date interceptors package
2 parents 379d78a + 63dcc63 commit fa9afe6

File tree

3 files changed

+9
-25
lines changed

3 files changed

+9
-25
lines changed

projects/date-interceptors/CHANGELOG.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,12 @@ All notable changes to this project will be documented in this file.
55
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
66
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
77

8+
## [1.0.1] - 2023-08-26
9+
10+
### Fixed
11+
12+
- several areas of the README
13+
814
## [1.0.0] - 2023-08-25
915

1016
### Changed

projects/date-interceptors/README.md

Lines changed: 2 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -32,32 +32,10 @@ ng add @ngx-toolset/date-interceptors
3232

3333
## Usage
3434

35-
### Module Import
36-
37-
Import the `DateInterceptorsModule` in your `AppModule`:
38-
39-
```ts
40-
import { NgModule } from '@angular/core';
41-
import { BrowserModule } from '@angular/platform-browser';
42-
import { AppComponent } from './app.component';
43-
import { DateInterceptorsModule } from '@ngx-toolset/date-interceptors';
44-
45-
@NgModule({
46-
declarations: [AppComponent],
47-
imports: [
48-
BrowserModule,
49-
DateInterceptorsModule.forRoot(),
50-
],
51-
bootstrap: [AppComponent],
52-
})
53-
export class AppModule {}
54-
```
55-
5635
### Provide Injection Tokens
5736

58-
Provide proper values for `API_DATE_FORMAT`, `API_URL_REGEX` and `DATE_STRING_REGEX` in your `AppModule`.
59-
60-
> Hint: The list of options to provide `API_DATE_FORMAT` value could be found here: [date-fns documentation](https://date-fns.org/v2.29.1/docs/parse).
37+
Provide proper values for automatically added `API_DATE_FORMAT`, `API_URL_REGEX` and `DATE_STRING_REGEX`
38+
injection tokens in your `AppModule`.
6139

6240
## Injection Tokens
6341

projects/date-interceptors/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "@ngx-toolset/date-interceptors",
3-
"version": "1.0.0",
3+
"version": "1.0.1",
44
"scripts": {
55
"build": "tsc -p tsconfig.schematics.json",
66
"postbuild": "copyfiles schematics/*/schema.json schematics/*/files/** schematics/collection.json ../../dist/date-interceptors/"

0 commit comments

Comments
 (0)