tate 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c15ce5da2418254dc9031e1d23b887de52b07d2a
-  data.tar.gz: 0d50f23086897df764f919ca69fb2435d4147a73
+  metadata.gz: 5199b949ebc1efadf042cbb06f99d0701620e464
+  data.tar.gz: d805ee53642bd09655732a545b560459fe9c54a4
 SHA512:
-  metadata.gz: 991d0290e7257074bbda1c82faea67d11cfccfdfbdea4ce95394d0e8ee1b29322f6e6e1403c96d4ceb852e54c93937513663318813f9723252869d2a1de69255
-  data.tar.gz: d10a64fd566f8a77ce18938125bc056db7a98342ca8a3aa7e4737ab9c22445a8d3e3bca281f0538f71d89d645b3f5f4988deb3c8f5b5b757df8cf8ed8b4527d5
+  metadata.gz: 5f04b40a7581eaf2a75bc750df7476a59b96b7bc5a268c9dca7302c27565f6584cd76cf5346d52ce2ee502d4e5b270186a99ccc982bf5aea0602c11cbbe93800
+  data.tar.gz: db19087b78f6e9abd26872a6fc09cd4f1ccd656ac65c8d23041aa7bb1d02349de49c96cdcbb7dfa7286de9947fedb2bb1c07b8cac13888c5761e8e238f1ffc07

data/README.md

@@ -1,8 +1,8 @@
 # Tate
 
-Welcome to your new gem! 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/tate`. To experiment with that code, run `bin/console` for an interactive prompt.
+**tate** helps you convert accented characters to ASCII.
 
-TODO: Delete this and the text above, and describe your gem
+**tate** is a productivity tool, it behaves like a standard Unix application and can be chained with other Unix commands. It only reads from standard input and writes to standard output.
 
 ## Installation
 
@@ -14,22 +14,57 @@ gem 'tate'
 
 And then execute:
 
-    $ bundle
+```sh
+$ bundle
+```
 
 Or install it yourself as:
 
-    $ gem install tate
+```sh
+$ gem install tate
+```
+
+## Examples
+
+Let's say you have a French sentence with a lot of weird characters and you want to convert it into ASCII in the most representative way. You can use:
+
+```sh
+echo "Le cœur de la crémiére" | tate  
+```
+
+This will output:
+
+```
+Le coeur de la cremiere
+```
 
-## Usage
+Or you might want to create a purely ASCII version of some file:
+
+```sh
+cat customers.csv | tate > customers_tated.csv
+```
 
-TODO: Write usage instructions here
+If you call `tate` without providing any input, like a standard Unix command it will expect you to provide input using the keyboard. After you are done typing you can use `cmd + D` shortcut to trigger `EOL (End of Line)`. You will see that the text you typed into the terminal is converted to ASCII.
 
-## Development
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+## Is it any good?
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+Yes.
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/krmbzds/tate.
+1. Fork it (https://github.com/krmbzds/tate/fork)
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request
+
+## Trivia
+
+**tate** is short for **transliterate**.  
+Nobody has time to type transliterate in the terminal.
+
+## License
+
+The MIT License (MIT)  
+Copyright (c) 2016 Kerem Bozdas

data/lib/tate/version.rb

@@ -1,3 +1,3 @@
 module Tate
-  VERSION = "0.1.1"
+  VERSION = "0.1.2"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tate
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Kerem Bozdas