pathing 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ff3d8c9d22d0eee8f8a4ee996b77e1a41a768339
-  data.tar.gz: 2086abcafcf1e8f00cd5e0b3b7620129f2192a29
+  metadata.gz: afb27fb129cf526ac658ac0df464f094791bb0e0
+  data.tar.gz: 8c8efa03a5f7fe2584c58d109520e600c8dcec99
 SHA512:
-  metadata.gz: fe8479732bb37702e52c7b4ad9b230ae95a76d9af7ec36b09be5b5b0a6f03259cdfe83dc64ac7724775d4c002d9322cd9bdaa68900e7afe8a3afcf945e2e3aca
-  data.tar.gz: d14ec4fb8c2ce9fdf604d3f09cfa25cc6458f720dbddc643bcb79775b35e81baba95b42408bcbd3f0ddfca58281e09d472fa8d7ffb735ae6c0d71fcb6a620021
+  metadata.gz: 82f0669c363d9566f91ac2966307addda396f275a2d4ef9cfa28454fff74e0b49fa65532cb12a36c90061bec0c6352f9c408550805fa7cfcb5e2d710a2dfc8bd
+  data.tar.gz: a4246a43c471472b9b16c7ac6590efcaac80b433c885e5bd76b95d70b971e3099dfc05f2a03d15fd11e3fc8e9516ba601f72129682ca0f006f19399ad9ffbc7e

data/README.md

@@ -1,2 +1,56 @@
-# pathing
+# pathing v0.1.1
+
 Dijkstra's algorithm pathfinding in Ruby
+
+## Features
+
+- **Quick** - written in C as a Ruby extension!
+- **Flexible** - use your own graph interface!
+- **Simple** - describe your graph, call one method, and you have your path!
+
+## Sample Usage
+
+The easiest way to download the gem is to use [Bundler](http://bundler.io/) with a Gemfile. In your Gemfile, include the line `gem 'pathing'`. Then you can run `bundle install` to automatically download and compile the gem for your system. To include the gem in a Ruby file, use the line `require 'pathing'`.
+
+To do some pathfinding, first set up a graph interface object. This object defines the entire layout of your graph. The following example is one way of achieving a two-dimensional grid with neighbors only in the cardinal directions.
+```
+class Interface
+  SIZE = 32
+
+  # gets an array of neighbors for the given node key
+  # for this example, the node key is passed in as an array like so: [x, y]
+  def neighbors_for(node_key)
+    x, y = *node_key
+    neighbors = []
+    
+    neighbors << [x-1, y] if x > 0
+    neighbors << [x, y-1] if y > 0
+    neighbors << [x+1, y] if x < SIZE-1
+    neighbors << [x, y+1] if y < SIZE-1
+    
+    neighbors
+  end
+  
+  # gets the cost for moving from node1 to node2
+  def edge_cost_between(node1_key, node2_key)
+    1
+  end
+end
+```
+
+Now, create a `Graph` object referencing your interface object.
+```
+graph = Pathing::Graph.new(Interface.new)
+```
+
+You're all set. Simply call
+```
+graph.path([0,0], [15, 20])
+```
+to get your optimized path!
+
+## Credits
+
+Copyright (c) 2015 [Nick Lowery](https://github.com/ClockVapor)
+
+View LICENSE for full license.

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pathing
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Nick Lowery
@@ -24,7 +24,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: Dijkstra's algorithm pathfinding
+description: Quick and flexible Dijkstra's algorithm pathfinding
 email: nick.a.lowery@gmail.com
 executables: []
 extensions:
@@ -42,7 +42,7 @@ files:
 - ext/pathing/pathing.c
 - ext/pathing/pathing.h
 - ext/pathing/util.h
-homepage: https://github.com/ClockVapor/pathing
+homepage: ''
 licenses:
 - MIT
 metadata: {}
@@ -65,5 +65,5 @@ rubyforge_project:
 rubygems_version: 2.4.3
 signing_key: 
 specification_version: 4
-summary: Dijkstra's algorithm pathfinding
+summary: Quick and flexible Dijkstra's algorithm pathfinding
 test_files: []