Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
Crossed JSON array creation from TODO.
  • Loading branch information
jkesselring committed Mar 6, 2015
1 parent 5363b3a commit d3b061a
Showing 1 changed file with 5 additions and 4 deletions.
9 changes: 5 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

0 comments on commit d3b061a

Please sign in to comment.