Skip to content

Commit afe2e23

Browse files
committed
docs: update README.md for improved formatting and clarity
1 parent 6872002 commit afe2e23

File tree

1 file changed

+18
-15
lines changed

1 file changed

+18
-15
lines changed

README.md

Lines changed: 18 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,30 +1,33 @@
11
# Composer Upgrader
22

3-
[![Latest Stable Version](https://poser.pugx.org/vildanbina/composer-upgrader/v)](https://packagist.org/packages/vildanbina/composer-upgrader) [![Total Downloads](https://poser.pugx.org/vildanbina/composer-upgrader/downloads)](https://packagist.org/packages/vildanbina/composer-upgrader) [![License](https://poser.pugx.org/vildanbina/composer-upgrader/license)](https://packagist.org/packages/vildanbina/composer-upgrader) [![PHP Version Require](https://poser.pugx.org/vildanbina/composer-upgrader/require/php)](https://packagist.org/packages/vildanbina/composer-upgrader)
3+
[![GitHub Workflow Status (master)](https://img.shields.io/github/actions/workflow/status/vildanbina/composer-upgrader/tests.yml?label=Tests)](https://github.com/vildanbina/composer-upgrader/actions)
4+
[![Total Downloads](https://img.shields.io/packagist/dt/vildanbina/composer-upgrader)](https://packagist.org/packages/vildanbina/composer-upgrader)
5+
[![Latest Version](https://img.shields.io/packagist/v/vildanbina/composer-upgrader)](https://packagist.org/packages/vildanbina/composer-upgrader)
6+
[![License](https://img.shields.io/packagist/l/vildanbina/composer-upgrader)](https://packagist.org/packages/vildanbina/composer-upgrader)
47

58
---
69

7-
## 🌟 Introduction
10+
## Introduction
811

912
**Composer Upgrader** is a sleek and powerful Composer plugin designed to simplify dependency management. With a single command, upgrade all your project dependencies to their latest versions effortlessly. Key features include:
1013

11-
- 🚀 **Customizable Upgrades**: Choose between major, minor, or patch-level updates.
12-
- 🎯 **Targeted Control**: Update specific packages with precision.
13-
- 🛡️ **Stability Options**: Tailor upgrades to your preferred stability level.
14-
- 🔍 **Safe Previews**: Test changes before applying them.
14+
- **Customizable Upgrades**: Choose between major, minor, or patch-level updates.
15+
- **Targeted Control**: Update specific packages with precision.
16+
- **Stability Options**: Tailor upgrades to your preferred stability level.
17+
- **Safe Previews**: Test changes before applying them.
1518

1619
This plugin updates your `composer.json` and lets you take the final step with `composer update`, keeping you in charge!
1720

1821
---
1922

20-
## 🛠️ Requirements
23+
## Requirements
2124

2225
- **PHP**: `^8.0+`
2326
- **Composer**: `2.x`
2427

2528
---
2629

27-
## 📦 Installation
30+
## Installation
2831

2932
Install the plugin via Composer:
3033

@@ -36,13 +39,13 @@ That’s it—no extra setup needed!
3639

3740
---
3841

39-
## ⚙️ Configuration
42+
## Configuration
4043

4144
No configuration files required! Customize everything through command-line options for a lightweight experience.
4245

4346
---
4447

45-
## 🎮 Commands
48+
## Commands
4649

4750
### `upgrade-all`
4851

@@ -105,7 +108,7 @@ composer update
105108

106109
---
107110

108-
## Features
111+
## Features
109112

110113
- **Precision Upgrades**: Selectively target major, minor, or patch updates.
111114
- **Package Filtering**: Focus on specific dependencies with `--only`.
@@ -115,26 +118,26 @@ composer update
115118

116119
---
117120

118-
## 🤝 Contributing
121+
## Contributing
119122

120123
Love to improve this tool? Check out [CONTRIBUTING](.github/CONTRIBUTING.md) for how to dive in—bug fixes, features, or docs welcome!
121124

122125
---
123126

124-
## 🔒 Security Vulnerabilities
127+
## Security Vulnerabilities
125128

126129
Spot a security concern? Email [vildanbina@gmail.com](mailto:vildanbina@gmail.com) directly—we’ll address it promptly!
127130

128131
---
129132

130-
## 🌟 Credits
133+
## Credits
131134

132135
- **[Vildan Bina](https://github.com/vildanbina)** – Creator & Lead Developer
133136
- **All Contributors** – Thanks for your awesome support! ([See contributors](../../contributors))
134137

135138
---
136139

137-
## 📜 License
140+
## License
138141

139142
Licensed under the MIT License (MIT). See [License File](LICENSE.md) for details.
140143

0 commit comments

Comments
 (0)