agx-chat-web 0.5.6 → 0.5.8

package/README.md

@@ -1,9 +1,49 @@
-Generic implementation of Chat from AGX Software applications.
+Generic Chat implementation for AGX Software applications.
 
-## Introduction
+## Links
 
-Here is the near future will have a great docs.
+NPM link:
+https://www.npmjs.com/package/agx-chat-web
 
-## Tutorial 
 https://betterprogramming.pub/how-to-create-and-publish-react-typescript-npm-package-with-demo-and-automated-build-80c40ec28aca#48c1
 
+## Deploy
+
+Steps to make a new version:
+
+- change the version in package.json
+- npm login (using a package maintainer account)
+- yarn deploy
+
+## Running the project locally for feature development
+
+To run the project locally and add new features, follow these steps:
+
+---
+
+### Step 1: Familiarize yourself with `yarn link`
+Before proceeding, review the documentation for `yarn link` to understand how it works:
+[yarn link Documentation](https://classic.yarnpkg.com/lang/en/docs/cli/link/)
+
+### Step 2: Build and link the project
+1. Navigate to the root directory of this project
+2. Run the following commands:
+   ```bash
+   yarn build
+   yarn link
+   ```
+3. After running yarn link, you will see a message similar to this:
+  You can now run `yarn link "agx-chat-web"` in the projects where you no longer want to use this package.
+
+### Step 3: Link the project to your application
+1. Navigate to the root directory of your application (e.g., ~/projects/line-web)
+2. Run the following commands:
+  ```bash
+  yarn link "agx-chat-web"
+  yarn install --force
+  ```
+3. Once the linking process is complete, you can start your application. It will now use the locally linked agx-chat-web package for development.
+4. When you change the code in the chat application, you can run the following command to update the linked version:
+  ```bash
+  yarn deploy-dev  
+  ```