README.md in comfan-0.1.0 vs README.md in comfan-0.1.1
- old
+ new
@@ -18,20 +18,30 @@
$ gem install comfan
## Usage
+To get access to the functions require the gem with `require 'comfan'`
+
### api_id
This method returns a API ID for the input ID. If the input already is an API (length >= 18 character), the same ID is returned.
Otherwise the API ID is calculated
+~~~ ruby
+Comfan.api_id '0D50000000IehZ' # 00D50000000IehZEAS
+~~~
+
### ui_id
This is method converts an API ID to an UI ID. If an UI ID is provided (length <= 15 characters), the same ID is returned.
Otherwise the UI ID is calculated
+
+~~~ ruby
+Comfan.api_id '00D50000000IehZEAS' # 0D50000000IehZ
+~~~
## Contributing
1. Fork it
2. Create your feature branch (`git checkout -b my-new-feature`)
\ No newline at end of file