Update README.md and package.json (#10)

yurakhomitsky · Aug 10, 2024 · cc72785 · cc72785
1 parent 3bda6dc
commit cc72785
Show file tree

Hide file tree

Showing 3 changed files with 16 additions and 8 deletions.
diff --git a/README.md b/README.md
@@ -1,6 +1,14 @@
-# NgxViewState
+<h1 style="text-align: center">NgxViewState</h1>
+
+>Library for managing Loading/Success/Error in Angular applications that use NgRx.
+
+
 This repository contains example of using `ngx-view-state` library in Angular application and the library itself.
 
+## Library Documentation
+
+For more information about the library, please refer to the [library documentation](./projects/ngx-view-state/README.md)
+
 ## Development server
 
 Run `npm run build-lib watch` to build the library.
@@ -10,6 +18,3 @@ Run `npm run start` for a dev server for the Application. Navigate to `http://lo
 #### Stackblitz Example
 [https://stackblitz.com/edit/ngx-view-state](https://stackblitz.com/edit/ngx-view-state)
 
-## Library Documentation
-
-If you're interested in using the library, please see the [library documentation](./projects/ngx-view-state/README.md).
diff --git a/projects/ngx-view-state/README.md b/projects/ngx-view-state/README.md
@@ -1,6 +1,6 @@
 <h1 style="text-align: center;">NgxViewState</h1>
 
-The `ngx-view-state` library is designed to simplify managing view states of HTTP requests in Angular applications that use NGRX.
+The `ngx-view-state` library is designed to simplify managing view states(Loading, Success, Error) of HTTP requests in Angular applications that use NGRX.
 
 This library provides set of utils that allow developers to handle different view states such as loading, error, and loaded states.
 
@@ -11,8 +11,9 @@ This library provides set of utils that allow developers to handle different vie
 * [Usage ngxViewState directive](#usage-ngxviewstate-directive)
 * [Components customization](#components-customization)
 * [Usage with HttpClient](#usage-with-httpclient)
+* [Documentation](#documentation)
 
-#### [Stackblitz Example](https://stackblitz.com/edit/ngx-view-state)
+### [Stackblitz Example](https://stackblitz.com/edit/ngx-view-state)
 
 ### [Medium blog post](https://medium.com/@yura.khomitsky8/a-single-state-for-loading-success-error-in-ngrx-e50c5d782478)
 

diff --git a/projects/ngx-view-state/package.json b/projects/ngx-view-state/package.json
@@ -1,14 +1,16 @@
 {
   "name": "ngx-view-state",
-  "version": "3.0.0",
+  "version": "3.0.1",
   "license": "MIT",
   "description": "ngx-view-state is a library for managing the Loading/Success/Error states of views in Angular applications that use Ngrx or HttpClient",
   "author": "Yurii Khomitskyi <yura.khomitsky8@gmail.com>",
   "private": false,
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/yurakhomitsky/ngx-view-state.git"
+    "url": "git+https://github.com/yurakhomitsky/ngx-view-state.git",
+    "directory": "projects/ngx-view-state"
   },
+  "homepage": "https://github.com/yurakhomitsky/ngx-view-state",
   "keywords": [
     "Angular",
     "NgRx",