updated README.md, created CHANGELOG.md and update-changelog.yml work…

…flow

.github/workflows/update-changelog.yml

@@ -0,0 +1,32 @@
+name: "Update Changelog"
+
+on:
+  release:
+    types: [released]
+
+permissions:
+  contents: write
+
+jobs:
+  update:
+    runs-on: ubuntu-latest
+    timeout-minutes: 5
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+        with:
+          ref: main
+
+      - name: Update Changelog
+        uses: stefanzweifel/changelog-updater-action@v1
+        with:
+          latest-version: ${{ github.event.release.name }}
+          release-notes: ${{ github.event.release.body }}
+
+      - name: Commit updated CHANGELOG
+        uses: stefanzweifel/git-auto-commit-action@v5
+        with:
+          branch: main
+          commit_message: Update CHANGELOG
+          file_pattern: CHANGELOG.md

README.md

@@ -7,9 +7,9 @@
 
 a composer package to install globally and remove composer vendor folders in you old project to save storage.
 
-## Installation
+## Installation && Update
 
-You can install the package globally via composer:
+You can install the package globally via composer (and update it) by running the following command:
 
 ```bash
 composer global require abdelhamiderrahmouni/vendorkill
@@ -43,17 +43,11 @@ vendorkill /path/to/project --maxdepth=4 # remove vendor folders in /path/to/pro
 vendorkill /path/to/project --full # remove vendor folders in /path/to/project and all subdirectories
 ```
 
-## Update
-
-```bash
-
-```
-
-## Testing
-
-```bash
-composer test
-```
+## Roadmap
+- [x] create the command
+- [ ] add support for windows
+- [ ] add a build workflow to build the phar file automatically
+- ... share your ideas in the [issues](https://github.com/abdelhamiderrahmouni/vendorkill/issues)
 
 ## Changelog
 
@@ -65,7 +59,7 @@ Please see [CONTRIBUTING](CONTRIBUTING.md) for details.
 
 ## Security Vulnerabilities
 
-Please review [our security policy](../../security/policy) on how to report security vulnerabilities.
+Please open an [issue](https://github.com/abdelhamiderrahmouni/vendorkill/issues) to report any security vulnerabilities.
 
 ## Credits