diff --git a/README.md b/README.md index 4eceb62..1a2f569 100644 --- a/README.md +++ b/README.md @@ -4,13 +4,7 @@ The PHP SimpleCache Class is an easy way to cache 3rd party API calls. ## Install -You can either download the class manually and "require": - -```php -require('SimpleCache.php'); -``` - -or you can install via [composer](https://getcomposer.org): +Install via [composer](https://getcomposer.org): ```javascript { @@ -20,22 +14,27 @@ or you can install via [composer](https://getcomposer.org): } ``` +Run `composer install` then use as normal: + +```php +require 'vendor/autoload.php'; +$cache = new Gilbitron\Util\SimpleCache(); +``` + ## Usage A very basic usage example: ```php -require('SimpleCache.php'); -$cache = new SimpleCache(); +$cache = new Gilbitron\Util\SimpleCache(); $latest_tweet = $cache->get_data('tweet', 'http://search.twitter.com/search.atom?q=from:gilbitron&rpp=1'); echo $latest_tweet; ``` - + A more advanced example: ```php -require('SimpleCache.php'); -$cache = new SimpleCache(); +$cache = new Gilbitron\Util\SimpleCache(); $cache->cache_path = 'cache/'; $cache->cache_time = 3600; diff --git a/composer.json b/composer.json index cc7677a..44f20a0 100644 --- a/composer.json +++ b/composer.json @@ -19,8 +19,8 @@ "php": ">=5.3.0" }, "autoload": { - "files" : [ - "simpleCache.php" - ] + "psr-4": { + "Gilbitron\\Util\\": "src/" + } } } diff --git a/SimpleCache.php b/src/SimpleCache.php similarity index 92% rename from SimpleCache.php rename to src/SimpleCache.php index df02120..cb11f37 100644 --- a/SimpleCache.php +++ b/src/SimpleCache.php @@ -1,6 +1,9 @@ is_cached($label)){ - $filename = $this->cache_path . $this->safe_filename($label) . $this->cache_extension; + $filename = $this->cache_path . $this->safe_filename($label) . $this->cache_extension; return file_get_contents($filename); }