rubyllipse 1.0.1 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 95b3572740540c68050c67697a52171894cc2fdb79b46f5d7cd4ca5decb154c4
-  data.tar.gz: 1389621c09cddcafda1e4e2935bd32c90942d16865866a6cec403dc2d3d239d6
+  metadata.gz: b90036731499e91eec0e5d85eafe84479cc2bd5440806fdb7b5d203a19e3b391
+  data.tar.gz: d0ee6d8b9093660c95b8d3691b61403f4a5a277d253c496bf214c9e33d18ff5a
 SHA512:
-  metadata.gz: 336ce04240a084a196457569d7fc5315a9595b5dde25d0fc9a177d3a3bb2b2bda4e30fcafacea0365dbed3d97454d6a014d68ab1e2f5d14c0c58fd5dd5f4efc3
-  data.tar.gz: e0e4f2a4cb97d87f4bd1adf397436a17fc5385ec9c5d67130a152608642e47237f238bcc74bfe6e5c55f1943cd7bf03a05bca47bab4a23116cfbd08a5ebdc2fa
+  metadata.gz: 6bdc3c2112011d28519a372a7bdd11a15c64ccefca605b8fb17affe1766d749d89d12be83c4be1a4a021f5f9988fc63aac48fba215ce1085021833ae09017f61
+  data.tar.gz: 5ef9142acd80b13d40971bb978bfaf73f11fdf4cacdcb54fee813248993d3e4405ceb0e9176f599707713212518597fc00f56f5677a4b37e95705336c158798a

data/README.md

@@ -0,0 +1,21 @@
+# Rubyllipse
+Yes, I know the name's dumb.
+
+A simple gem for managing and playing with ellipses.
+
+## Usage
+
+Create a new ```Ellipse``` object: ```Rubyllipse::Ellipse::new(major_radius, minor_radius, center_coordinates)```; ```myellipse = Rubyllipse::Ellipse::new(3, 3, [0,0])```.
+
+```myellipse.is_circle? == True``` as we can see we just created a circle. ```myellipse.area```, ```myellipse.perimeter``` will return the circle's area, perimeter.
+
+```myellipse.move_horizontally(3)``` will move the ellipse by 3 units towards the positive horizontal way and reinitialize the ```myellipse``` object. 
+
+One of the most important aspects of an ```Ellipse``` object is the ```form``` attribute. it can be either set to ```'horizontal'``` or ```'vertical'``` and it determines if the ellipse's major-axis will be vertical or horizontal (tilted, rotated ellipses are not available yet).
+
+Another important method is ```give_function!```. It returns a string for the purpose of mainly displaying the function of the ```Ellipse``` object.
+
+Other methods are for accessing the object's attributes and don't need further explanation. 
+
+## Notes
+If you used the module and found something odd, bad, please send me an e-mail; I am still new to Ruby.

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rubyllipse
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.2
 platform: ruby
 authors:
 - Burzum
@@ -14,8 +14,10 @@ description:
 email: 
 executables: []
 extensions: []
-extra_rdoc_files: []
+extra_rdoc_files:
+- README.md
 files:
+- README.md
 - lib/rubyllipse.rb
 homepage: 
 licenses: []