Merge pull request #129 from MekDrop/fix-readme-links

Fixed README.md links + improved some text

Author: MekDrop

README.md

@@ -5,11 +5,11 @@
 
 GitHub action to filter PHP class list with [Glob like syntax](https://en.wikipedia.org/wiki/Glob_(programming)).
 
-We recommend to use this GitHub action with [impresscms-dev/generate-php-project-classes-list-file-action](https://github.com/impresscms-dev/generate-php-project-classes-list-file-action).
+We recommend using this GitHub action with [impresscms-dev/generate-php-project-classes-list-file-action](https://github.com/impresscms-dev/generate-php-project-classes-list-file-action).
 
 ## Usage
 
-To use this action in your project, create workflow in your project similar to this code (Note: some parts and arguments needs to be altered):
+To use this action in your project, create a workflow file similar to the example below (Note: you may need to adjust some parts and arguments to fit your specific needs):
 ```yaml
 name: Get filtered PHP classes list
 
@@ -21,8 +21,8 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkouting project code...
-        uses: actions/checkout@v2
-        
+        uses: actions/checkout@v4
+
       - name: Install PHP
         uses: shivammathur/setup-php@v2
         with:
@@ -31,46 +31,60 @@ jobs:
           ini-values: post_max_size=256M
           coverage: none
           tools: composer:v2
-          
+
       - name: Install Composer dependencies (with dev)
         run: composer install --no-progress --prefer-dist --optimize-autoloader
-          
+
       - name: Getting PHP classes list...
         uses: impresscms-dev/[email protected]
         with:
           output_file: ./php-classes.lst
-          
+
       - uses: DamianReeves/[email protected]
         with:
           path: ./filtering-rules.lst
           contents: |
             ImpressCMS\**
           write-mode: overwrite
-      
+
       - name: Filtering PHP classes list...
         uses: impresscms-dev/filter-php-class-list-with-glob-like-rules-action@v2
         with:
           rules_file: ./filtering-rules.lst
           input_file: ./php-classes.lst
           output_file: ./php-classes-filtered.lst
-          
+
       - uses: actions/upload-artifact@v3
         with:
           name: my-artifact
           path: ./php-classes-filtered.lst
 ```
 
-## Arguments 
+## Arguments
+
+This action supports the following arguments (specified under the `with` keyword in your workflow file):
 
-This action supports such arguments (used in `with` keyword):
 | Argument    | Required | Default value        | Description                       |
 |-------------|----------|----------------------|-----------------------------------|
 | rules_file | Yes      |                      | File with rules list (each rule separate line - like [.gitignore](https://git-scm.com/docs/gitignore)) |
 | input_file | Yes      |                      | File with PHP class names list |
 | output_file | Yes      |                      | File where result will be written |
 
-## How to contribute? 
+## How to contribute
+
+Contributions are welcome! If you'd like to add new features or fix bugs:
+
+1. Fork the repository
+2. Create a new branch for your feature or bugfix
+3. Implement your changes
+4. Submit a pull request
+
+If you're new to this process, check out GitHub's [Fork a repo](https://docs.github.com/en/get-started/quickstart/fork-a-repo) and [Creating a pull request](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request) guides.
+
+## Reporting issues
 
-If you want to add some functionality or fix bugs, you can fork, change and create pull request. If you not sure how this works, try [interactive GitHub tutorial](https://skills.github.com).
+Found a bug or have a suggestion? Please use the [GitHub Issues](https://github.com/impresscms-dev/filter-php-class-list-with-glob-like-rules-action/issues) page to:
 
-If you found any bug or have some questions, use [issues tab](https://github.com/impresscms-dev/filter-php-class-list-with-glob-like-rules-action/issues) and write there your questions.
+- Report bugs
+- Request new features
+- Ask questions about the project