Merge pull request #18 from RonasIT/12_change_readme

feat: change readme

Author: DenTray

CONTRIBUTING.md

@@ -0,0 +1,19 @@
+# CONTRIBUTING
+
+Contributions are welcome, and are accepted via pull requests.
+Please review these guidelines before submitting any pull requests.
+
+## Process
+
+1. Fork the project
+2. Create a new branch
+3. Code, test, commit and push
+4. Open a pull request detailing your changes. Make sure to follow the [template](.github/PULL_REQUEST_TEMPLATE.md)
+
+## Guidelines
+
+* Please follow the [PSR-12 Coding Style Guide](https://www.php-fig.org/psr/psr-12/).
+* Send a coherent commit history, making sure each individual commit in your pull request is meaningful.
+* Please follow the [Conventional Commits specification](https://www.conventionalcommits.org/en/v1.0.0/).
+* You may need to [rebase](https://git-scm.com/book/en/v2/Git-Branching-Rebasing) to avoid merge conflicts.
+* Please remember that we follow [SemVer](http://semver.org/).

README.md

@@ -1,4 +1,4 @@
-# laravel-project-initializator
+# Laravel Project initializator
 
 ## Installation
 
@@ -7,7 +7,20 @@
 ```
 
 ## Usage
- 1. run `php artisan init {application name}` - generate the Readme.md file and install required packages.
+
+To begin the initialization process, run `php artisan init {application name}`. 
+This will prompt you with questions regarding the project and the necessary packages for the initial setup.
+Upon completion:
+ - A new README.md file will be created
+ - `.env` files will be configured
+ - Necessary packages will be installed
+ - This package will be automatically removed
+
+## Contributing
+
+Thank you for considering contributing to Laravel Project initializator package! The contribution guide
+can be found in the [Contributing guide](CONTRIBUTING.md).
 
 ## License
+
 Laravel Project Initializator package is open-sourced software licensed under the [MIT license](LICENSE).