From 06ed816dfa9265a9fd585b09382823058dab8f79 Mon Sep 17 00:00:00 2001 From: "Carlos Alberto B. Carucce" Date: Fri, 21 Jun 2024 16:32:25 -0300 Subject: [PATCH] updating readme --- README.md | 26 ++++++++++++++++++++++++++ 1 file changed, 26 insertions(+) diff --git a/README.md b/README.md index 41804e7..32955ab 100644 --- a/README.md +++ b/README.md @@ -7,3 +7,29 @@ [![License](https://poser.pugx.org/webdevcave/simple-cache/license?format=flat-square)](https://packagist.org/packages/webdevcave/simple-cache) PSR Simple Cache Implementation + +Simple Cache caching data. +It provides a simple and intuitive API to cache data in files on the server. +This can be particularly useful for speeding up applications by reducing the need to fetch data from external +sources repeatedly. + +## Features +- Simple Interface: Easy-to-use API for caching data. +- File-based Storage: Data is cached in files on the server. +- TTL (Time To Live) Support: Set expiration times for cached data. +- Namespacing: Organize cached data using namespaces. +- Composer Support: Install via Composer for easy integration with existing projects. +- Installation +- You can install Simple Cache PHP via Composer. Run the following command in your terminal: + +```bash +composer require webdevcave/simple-cache-php +Alternatively, you can clone the repository or download the source files directly and include them in your project. +``` + +## Contributing +Contributions are welcome! If you find any issues or have suggestions for improvements, +please open an issue or a pull request on GitHub. + +## License +This project is licensed under the MIT License - see the LICENSE file for details.