alch 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 617a0a12f9f2da25046bdd402c248e76ef1048e8
-  data.tar.gz: ba05835bfe9aa78861c34936d7d35bf79cccfdf6
+  metadata.gz: 6fb60e6e423677cd1c0488e22874d87cc542b8dd
+  data.tar.gz: 0cdc2a36fc4e601a49066dc2978af99862f5aa5d
 SHA512:
-  metadata.gz: 61864e4634bf09e9c0b83f7e15bb83e97bd372b00172b8fa4e0d5c4709da55a26864887878bb1d54c0462e0e198fa5443f38287423a6ba0dc49d7eb07beffcb4
-  data.tar.gz: 922f4196c930b09fa2bd590904a101da197bcc1f312bfe4169dd27979a5474db0309060365e2ec70b2d8a9e5c1760eac2b1c163c31f6026ee2b9acdb56bca2d6
+  metadata.gz: f5b84d51c8348384ba2ddea3cd34e797b6cf413cb519e7237083d8efecf5a8de2de42f894c75a64196ef2d1cdc74e3001695d958f4e78ade1735108898e71d5c
+  data.tar.gz: c265351ae3da28092cc72d2c427c768f96f230ec0fcfaafab5b895fac587e432bbeb9e84935767575bf010bc46c4ea2c38846a7f19b9439a0495f8fe2b019db6

data/README.md

@@ -0,0 +1,51 @@
+# Alch.rb
+A very simplistic Runescape Alchemy API that can help you get alch prices of certain items.  It's written in Ruby so that it can also be easily accessable within Rails.
+
+## Installation
+You can download the newest version of Alch.rb through Git.  Just enter the following in your command line:
+
+`$ gem install alch`
+
+That's it! You are now able to include the API into your projects.
+
+To do so, include the src files in your project and when you'd like to use this API in a Class, just require the `alch.rb` file like so:
+
+```ruby
+require 'alch'
+```
+
+### Dependencies
+Since this was written in Ruby, you will need Ruby to use this API.
+
+## Usage Examples
+A very basic use case:
+```ruby
+require 'alch'
+
+# Create ruby and nature rune items
+item = new Item(1603)
+nature_rune = new Item(Runes::NATURE_RUNE_ID)
+
+# output => 'Profit from alching Ruby: -692'
+print "Profit from alching #{item.name}: "
+puts item.high_alch - (item.price + nature_rune.price)
+```
+
+Alternatively, you can also get the Item's ID by the Item's name.
+
+```ruby
+require 'alch'
+
+# Create ruby and nature rune items
+item = new Item(Item.id_by_name('ruby'))
+nature_rune = new Item(Runes::NATURE_RUNE_ID)
+
+# output => 'Profit from alching Ruby: -692'
+print "Profit from alching #{item.name}: "
+puts item.high_alch - (item.price + nature_rune.price)
+```
+
+# Full Documentation
+## Classes
+* **[Item.rb](https://github.com/RubySometimes/alchrb/blob/master/docs/classes/Item.md)**
+

data/lib/alch.rb

@@ -2,7 +2,7 @@
 # Released under the MIT License agreement
 
 # @author RubySometimes (GitHub)
-# @version 1.0.5
+# @version 0.0.1
 require_relative('alch/item')
 require_relative('alch/osrs')
 require_relative('alch/runes')

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: alch
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Marcello A. Sabino
@@ -16,6 +16,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- README.md
 - lib/alch.rb
 - lib/alch/item.rb
 - lib/alch/osrs.rb