Browse Source

Added PHP 5.4 requirement, support information and tweaked other parts of the composer and readme files.

Andrew Collington 10 years ago
parent
commit
a6324aab34
2 changed files with 30 additions and 6 deletions
  1. 17 3
      README.md
  2. 13 3
      composer.json

+ 17 - 3
README.md

@@ -1,6 +1,6 @@
 # opcache-gui
 
-A simple, responsive interface for Zend OPcache information showing the statistics, settings and cached files, and also provides a real-time update for the information (using jQuery and React).
+A clean and responsive interface for Zend OPcache information, showing statistics, settings and cached files, and providing a real-time update for the information (using jQuery and React).
 
 [![Flattr this git repo](http://api.flattr.com/button/flattr-badge-large.png)](https://flattr.com/submit/auto?user_id=acollington&url=https://github.com/amnuts/opcache-gui&title=opcache-gui&language=&tags=github&category=software)
 
@@ -14,6 +14,20 @@ The overview will show you all the core information.  From here you'll be able t
 
 ![Overview](http://amnuts.com/images/opcache/screenshot/overview-v2.png)
 
+### Getting started
+
+There are two ways to getting started using this gui.
+
+1. Simply to copy/paste or download the index.php to your server.
+2. Install via composer by adding this to your composer.json file:
+```json
+{
+    "require": {
+        "amnuts/opcache-gui": "*"
+    }
+ }
+```
+
 ### File usage
 
 All the files currently in the cache are listed here with their associated statistics.  You can filter the results very easily to key in on the particular scripts you're looking for, and you can optionally set levels of the path to be hidden (handy if they all share a common root and you don't want that displayed). It will also indicate if the file cache has expired.
@@ -30,9 +44,9 @@ The status.jsx file is provided solely for you to be able to edit the jsx code s
 
 The composer.json file is provided to allow you to deploy the opcache gui a little easier by using composer.
 
-## Previous releases
+## Releases
 
-Previous releases of the GUI are available at:
+Releases of the GUI are available at:
 
 https://github.com/amnuts/opcache-gui/releases/
 

+ 13 - 3
composer.json

@@ -1,6 +1,6 @@
 {
   "name": "amnuts/opcache-gui",
-  "description": "A gui for Zend OPcache with a simple & effective interface and real-time updates",
+  "description": "A clean and effective interface for Zend OPcache, with real(ish)-time monitoring, filtering and the ability to invalidate files",
   "keywords": ["opcache", "cache", "gui", "opcodes", "interface"],
   "minimum-stability": "stable",
   "license": "MIT",
@@ -8,11 +8,21 @@
     {
       "name": "Andrew Collington",
       "email": "andy@amnuts.com",
-      "homepage": "http://www.amnuts.com/"
+      "homepage": "http://www.amnuts.com/",
+      "role": "Developer"
+    },
+    {
+      "name": "Contributors",
+      "homepage": "https://github.com/amnuts/opcache-gui/graphs/contributors"
     }
   ],
+  "support": {
+    "email": "andy@amnuts.com",
+    "issues": "https://github.com/amnuts/opcache-gui/issues"
+  },
   "require": {
-    "ext-Zend-OPcache": "*"
+    "ext-Zend-OPcache": "*",
+    "php": ">=5.4"
   }
 }