README.md in starcall-0.1.1 vs README.md in starcall-0.2.0
- old
+ new
@@ -1,10 +1,11 @@
----
-[](https://travis-ci.com/kks110/starcall)
-
+
+
+
---
A Gem to help with calls to Riot API.
## Installation
@@ -21,17 +22,47 @@
gem install starcall
## Usage
+### Regions
+Sometimes, due to manual upload speeds, versions in different regions might be different or due to things like version specific bugs.
+Due to this, if you are looking for details of a specific region, it worth checking there rather than generically.
+
+A full list of supported regions can be obtained by running:
+```ruby
+Starcall::Regions.list
+```
+
+### Languages
+Things such as champion data is avalible in different languages.
+
+A full list of supported languages can be obtained by running:
+```ruby
+Starcall::Languages.list
+```
+
+
### Static Queries
-You can call any of the below methods like:
+First you need to initialise and instance of Starcall::StaticData
```ruby
-Starcall::StaticData.season_ids
+static_data = Starcall::StaticData.new
```
+Some of the queries below can return different data based on the region. When you initialize the class, you can pass in a valid region.
+Regions that Riot support can be queried as per the Regions section above.
+If no region is supplied, 'euw' will be assumed.
+
+Some of the queries below can be returned in different languages.
+Languages that Riot support can be queried as per the Languages section above.
+If no language is supplied, 'en_GB' (English Great Britain) will be assumed.
+
+```ruby
+Starcall::StaticData.new(region: 'kr', language: 'ko_KR')
+```
+
#### `season_ids`
Season ids are used in match history to indicate which season a match was played.
A full list of season ids can be retrieved with the below method.
@@ -50,40 +81,44 @@
A full list of game types can be can be retrieved with the below method.
#### Data Dragon
Data Dragon is Riots way of centralizing League of Legends game data and assets, including champions, items, runes, summoner spells, and profile icons.
All of which can be used by third-party developers.
-Please be aware that Riot update Data Dragon after each League of Legends manualy, so it is not always updated immediately after a patch.
+Please be aware that Riot update Data Dragon after each League of Legends manually, so it is not always updated immediately after a patch.
#### `dd_versions`
All valid Data Dragon versions can be can be retrieved with the below method.
Typically there's only a single build of Data Dragon for a given patch,
however occasionally there will be additional builds.
This typically occurs when there's an error in the original build.
As such, you should always use the most recent Data Dragon version for a given patch for the best results.
-#### `dd_euw_versions`
+#### `dd_region_versions`
+
Data Dragon versions aren't always equivalent to the League of Legends client version in a region.
You can find the version each region is using via the realms files.
-This function returns the EWU versions
#### `dd_champions`
+
This returns a list of all champion with a brief summary, including stats, id and blurb.
#### `dd_specific_champion(champion_name:)`
-For me detailed and specific information about a champion, this call can be used.
+For more detailed and specific information about a champion, this call can be used.
+
#### `dd_items`
+
Data Dragon also provides detail for every item in the game.
with this method you can find info such as the item's description, purchase value, sell value,
items it builds from, items it builds into, and stats granted from the item.
#### `dd_summoner_spells`
+
Details about summoner spells.
#### `dd_profile_icons`
-Details about profile icons and where they can be found on the sprite sheets.
+Details about profile icons and where they can be found on the sprite sheets.
## Development
After checking out the repo, run `bundle install` to install dependencies.