Add flair

This commit is contained in:
Zach Borboa
2024-08-24 13:22:18 -04:00
parent db6f650c47
commit bbcbb72c9e
2 changed files with 20 additions and 19 deletions
+17 -16
View File
@@ -12,18 +12,18 @@ PHP Curl Class makes it easy to send HTTP requests and integrate with web APIs.
---
- [Installation](#installation)
- [Requirements](#requirements)
- [Quick Start and Examples](#quick-start-and-examples)
- [Available Methods](#available-methods)
- [Security](#security)
- [Troubleshooting](#troubleshooting)
- [Testing](#testing)
- [Contributing](#contributing)
- [⚙️ Installation](#⚙️-installation)
- [📋 Requirements](#📋-requirements)
- [🚀 Quick Start and Examples](#🚀-quick-start-and-examples)
- [📖 Available Methods](#📖-available-methods)
- [🔒 Security](#🔒-security)
- [🛠️ Troubleshooting](#🛠️-troubleshooting)
- [🧪 Testing](#🧪-testing)
- [🤝 Contributing](#🤝-contributing)
---
### Installation
### ⚙️ Installation
To install PHP Curl Class, run the following command:
@@ -35,11 +35,11 @@ To install the latest commit version:
Installation instructions to use the `composer` command can be found on https://github.com/composer/composer.
### Requirements
### 📋 Requirements
PHP Curl Class works with PHP 8.3, 8.2, 8.1, 8.0, and 7.4.
### Quick Start and Examples
### 🚀 Quick Start and Examples
More examples are available under [/examples](https://github.com/php-curl-class/php-curl-class/tree/master/examples).
@@ -194,7 +194,7 @@ $multi_curl->start(); // Blocks until all items in the queue have been processed
More examples are available under [/examples](https://github.com/php-curl-class/php-curl-class/tree/master/examples).
### Available Methods
### 📖 Available Methods
```php
Curl::__construct($base_url = null, $options = [])
Curl::__destruct()
@@ -329,6 +329,7 @@ MultiCurl::close()
MultiCurl::complete($callback)
MultiCurl::disableTimeout()
MultiCurl::error($callback)
MultiCurl::getActiveCurls()
MultiCurl::getOpt($option)
MultiCurl::removeHeader($key)
MultiCurl::setAutoReferer($auto_referer = true)
@@ -376,19 +377,19 @@ MultiCurl::unsetProxy()
MultiCurl::verbose($on = true, $output = 'STDERR')
```
### Security
### 🔒 Security
See [SECURITY](https://github.com/php-curl-class/php-curl-class/blob/master/SECURITY.md) for security considerations.
### Troubleshooting
### 🛠️ Troubleshooting
See [TROUBLESHOOTING](https://github.com/php-curl-class/php-curl-class/blob/master/TROUBLESHOOTING.md) for help troubleshooting.
### Testing
### 🧪 Testing
See [TESTING](https://github.com/php-curl-class/php-curl-class/blob/master/TESTING.md) for testing information.
### Contributing
### 🤝 Contributing
1. Check for open issues or open a new issue to start a discussion around a bug or feature.
1. Fork the repository on GitHub to start making your changes.
+3 -3
View File
@@ -4,11 +4,11 @@ SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
cd "${SCRIPT_DIR}/.."
before=$(head -n $(
grep --context="0" --line-number --max-count="1" "### Available Methods" "README.md" |
grep --context="0" --line-number --max-count="1" "### 📖 Available Methods" "README.md" |
perl -pe 's/^(\d+):.*/\1/') "README.md")
after=$(tail -n +$(
grep --context="0" --line-number --max-count="1" "### Security" "README.md" |
grep --context="0" --line-number --max-count="1" "### 🔒 Security" "README.md" |
perl -pe 's/^(\d+):.*/\1/') "README.md")
echo "${before}" > "README.md"
@@ -48,7 +48,7 @@ echo "${after}" >> "README.md"
# Update table of contents.
script=$(cat <<'EOF'
$data = file_get_contents('README.md');
preg_match_all('/^### ([\w ]+)/m', $data, $matches);
preg_match_all('/^### (.*)/m', $data, $matches);
$toc = [];
foreach ($matches['1'] as $match) {
$href = '#' . str_replace(' ', '-', strtolower($match));