README.md in wahy-1.3.3 vs README.md in wahy-1.3.4

- old
+ new

@@ -1,11 +1,9 @@ # Wahy Welcome to my Wahy gem repo! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/wahy`. To experiment with that code, run `bin/console` for an interactive prompt. -TODO: Delete this and the text above, and describe your gem - ## Installation Add this line to your application's Gemfile: ```ruby @@ -21,35 +19,51 @@ $ gem install wahy ## Usage ```shell -Just install gem and use wahy command +# Just install gem and use wahy command # For help: wahy -h There is the argument's options: -# -l => to pick language ('eng'|'tur') # Default: tur (English) +# If you want to see English results you don't need to call -l argument (English is default) +# -l => to pick language ('eng'|'tur') # Default: (English) # -s => to pick scripture (also can use scripture's number) # between 1-114 # Default: 1 # -a => to pick sign number (also can use all) # Default: all -# User can call only wahy command then will see all sings of first scripture in Turkish. +# User can call only wahy command then will see all sings of first scripture in Engish. # The Cow Scripture and its all signs wahy -l 'eng' -s 'The Cow' # alias to: wahy -l 'eng' -s 'The Cow' -a 'all' wahy -l 'tur' -s 'The Cow' # alias to: wahy -l 'eng' -s 'The Cow' -a 'all' # The Cow Scripture and its 2nd sign wahy -l 'eng' -s 'The Cow' -a 2 wahy -l 'tur' -s 'The Cow' -a 2 -# Gem includes two XML files +# There is a little terminal trick to save output to a file: +wahy -l 'eng' -s 'The Cow' > fileName.txt # :) + +# Also in lib directory : wahy.rb is a executable file + +# Also you can use that gem as source of your own project +require 'wahy' + +data = Wahy.new_data 'tur' # or data = Wahy.new_data 'eng' +quran = Wahy.chapters_data data +the_opening = Wahy.scripture_data quran, 'the opening' # a nokogiri object +signs = Wahy.sign_data the_opening # an array +sign_one = signs[0] # or sign_one = signs.firsr # it's array +# OR +sing_two = Wahy.take_specific_sign signs, 1 + + +# Gem includes two XML data # English Quran Tranlation(eng.xml): Written by Yusuf Ali # Turkish Quran Tranlation(tur.xml): Written by Elmalılı Hamdi Yazır # Special Thanks to: http://www.qurandatabase.org/Database.aspx - -# Also in same directory : wahy.rb is a executable file ``` ## Development After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment. @@ -64,6 +78,6 @@ The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT). ## Code of Conduct -Everyone interacting in the Wahy project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/wahy/blob/master/CODE_OF_CONDUCT.md). +Everyone interacting in the Wahy project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/cptangry/wahy/blob/master/CODE_OF_CONDUCT.md).