Skip to content

README.md

Latest commit

 

History

History
116 lines (76 loc) · 4.22 KB

README.md

File metadata and controls

116 lines (76 loc) · 4.22 KB

🚀 async-cache-php - Fast and Efficient Caching for PHP

Download Now

📖 Description

async-cache-php is an asynchronous caching abstraction layer for PHP. It includes built-in rate limiting and supports stale-while-revalidate operations. This software is compliant with PSR-16, making it a reliable choice for developers who want to optimize their PHP applications. Improve the performance of your application easily and efficiently.

📋 Features

  • Asynchronous Caching: Store and retrieve data without blocking processes.
  • Rate Limiting: Control the speed of requests to improve resource management.
  • Stale-While-Revalidate: Serve outdated responses while refreshing cached data in the background.
  • PSR-16 Compliance: Aligns with PHP-FIG standards for interoperability.

🌟 System Requirements

  • PHP Version: 7.3 or higher
  • Memory: At least 256 MB
  • Storage: Minimum 50 MB available

🚀 Getting Started

Follow these steps to get started with async-cache-php:

  1. Visit the Releases Page
    Go to the releases page to find the software. You can get there by clicking here.

  2. Download the Latest Version
    Look for the latest version listed on the page. You will see the assets available for download. Click to download the file that meets your needs.

    Release Assets

  3. Install the Software

    • For Windows: Double-click the downloaded file and follow the installation prompts.
    • For macOS: Open the downloaded package and follow the on-screen instructions.
    • For Linux: Follow typical package installation commands, or refer to your distribution’s package manager.

  4. Verify Installation
    After installation, verify that async-cache-php is ready to use. Open your terminal or command prompt and type the following command:

    php -m | grep async-cache-php

    If you see async-cache-php in the list, you have successfully installed the application.

📦 How to Use

  1. Configuration
    Configure async-cache-php according to your application's requirements. Here’s a simple example:

    use AsyncCache\Cache;

$cache = new Cache([
    'engine' => 'memory',
    'stale' => true,
    'rate_limit' => 100
]);

  2. Basic Operations

    • Set a Cache Value:
    $cache->set('key', 'value', 3600); // Expires in 1 hour
    • Get a Cache Value:
    $value = $cache->get('key'); // Fetch the value

  3. Handling Cache Expiry
    Use the built-in functions to manage expired data effectively. This helps maintain performance by ensuring fresh data is available without significant delays.

🔧 Troubleshooting

  • Issue: The software does not appear in PHP modules.

    • Solution: Ensure that you have the correct PHP version installed and check the installation steps again.

  • Issue: Cache not refreshing as expected.

    • Solution: Check your configuration settings, specifically the rate limits and stale settings.

💬 Contributing

We welcome contributions to async-cache-php. If you want to help improve the software, follow these steps:

  1. Fork the repository.

  2. Create a new branch:

    git checkout -b feature/YourFeature

  3. Make your changes and commit them:

    git commit -m "Add your changes"

  4. Push to your branch:

    git push origin feature/YourFeature

  5. Submit a pull request.

📥 Download & Install

To download and install async-cache-php, follow this link to the Releases page: Download async-cache-php.

Click the link, select the latest version, and follow the installation steps provided earlier. Enjoy enhanced caching in your PHP projects.