README.md in galaxy_converter-2.1.2 vs README.md in galaxy_converter-3.0.1
- old
+ new
@@ -3,11 +3,10 @@
* [Design](#design)
* [SRP](#srp)
* [Roman numerals](#roman-numerals)
* [Installation](#installation)
* [Usage](#usage)
- * [Library](#library)
* [CLI](#cli)
## Scope
This gem is the Ruby implementation of the `Merchant's Guide to the Galaxy` code-kata.
@@ -26,38 +25,11 @@
gem install galaxy_converter
```
## Usage
-### Library
-Just require the library into your program and pass an array of notes to the converter:
-```ruby
-require "galaxy_converter"
-
-notes = ["glob is I", "prok is V", "pish is X", "tegj is L", "glob glob Silver is 34 Credits", "glob prok Gold is 57800 Credits", "pish pish Iron is 3910 Credits", "how much is pish tegj glob glob ?", "how many Credits is glob prok Silver ?", "how many Credits is glob prok Gold ?", "how many Credits is glob prok Iron ?", "how much wood could a woodchuck chuck if a woodchuck could chuck wood ? "]
-
-puts GalaxyConverter.call(notes)
-# pish tegj glob glob is 42
-# glob prok Silver is 68 Credits
-# glob prok Gold is 57800 Credits
-# glob prok Iron is 782 Credits
-# I have no idea what you are talking about
-```
-
### CLI
The gem provides a CLI interface.
-Once installed you will be able to use the `galaxy_converter` command from the terminal.
-
-#### Help
-You can print CLI help by:
-```shell
-galaxy_converter -h
-Usage: galaxy_converter ~/notes.txt
- -h --help Print this help
- <path-to-file> Load conversion notes
-```
-
-#### Input
The program accepts as input a file containing several conversion notes:
```txt
# ~/notes.txt
glob is I
prok is V