From d3b061aff9b2e361617530d4147e81b2e44b9bbe Mon Sep 17 00:00:00 2001 From: Joseph Date: Fri, 6 Mar 2015 14:43:03 -0500 Subject: [PATCH] Update README.md Crossed JSON array creation from TODO. --- README.md | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 49a9a30..b763909 100644 --- a/README.md +++ b/README.md @@ -3,17 +3,18 @@ worldmaker_PHP Port of a C# idea generation utility for World Building / Writing / RPGs, etc. -Use is pretty straightforward. In a new PHP file include Generate.php. +Use is pretty straightforward. In a PHP file include Generate.php. eg: require_once('Generate.php'); -Then simply: echo Generate::generateName() to generate a name. generateTitle, generateName, generatePlot, generatePlanet are the current four methods contained within which encompass the four categories originally implemented in the C# WorldMaker program. - +Then simply: echo Generate::name('name-of-json-file') to generate a name, title, plot, planet, weapon, and/or armor are the current methods implemented. This expands on the categories originally implemented in the C# WorldMaker program. Pull requests are amazing. Go for it! TODO ============= -Create JSON of arrays for cross language/platform usability. Why? To keep excessive fragmentation to a minimum if other versions/implementations exist. +~~Create JSON of arrays for cross language/platform usability. Why? To keep excessive fragmentation to a minimum if other versions/implementations exist.~~ + +Improve documentation. Original application created by: /u/Nextmastermind over on Reddit.