diff --git a/README.mkd b/README.mkd index d5c0630..b22bca6 100644 --- a/README.mkd +++ b/README.mkd @@ -4,9 +4,9 @@ If you want to get cracking on the ruby source then do this: Hi and welcome to team Gilded Rose. -As you know, we are a small inn with a prime location in a prominent city ran +As you know, we are a small inn with a prime location in a prominent city run by a friendly innkeeper named Allison. We also buy and sell only the finest -goods. Unfortunately, our goods are constantly degrading in quality as they +goods. Unfortunately, our goods are constantly degrading in `quality` as they approach their sell by date. We have a system in place that updates our inventory for us. It was developed @@ -16,45 +16,45 @@ new category of items. First an introduction to our system: - - All items have a SellIn value which denotes the number of days we have to + - All items have a `sell_in` value which denotes the number of days we have to sell the item - - All items have a Quality value which denotes how valuable the item is + - All items have a `quality` value which denotes how valuable the item is - At the end of each day our system lowers both values for every item Pretty simple, right? Well this is where it gets interesting: - - Once the sell by date has passed, Quality degrades twice as fast + - Once the sell by date has passed, `quality` degrades twice as fast - - The Quality of an item is never negative + - The `quality` of an item is never negative - - "Aged Brie" actually increases in Quality the older it gets + - "Aged Brie" actually increases in `quality` the older it gets - - The Quality of an item is never more than 50 + - The `quality` of an item is never more than 50 - "Sulfuras", being a legendary item, never has to be sold or decreases in - Quality + `quality` - - "Backstage passes", like aged brie, increases in Quality as it's SellIn - value approaches; Quality increases by 2 when there are 10 days or less - and by 3 when there are 5 days or less but Quality drops to 0 after the + - "Backstage passes", like aged brie, increase in `quality` as their `sell_in` + value approaches 0; `quality` increases by 2 when there are 10 days or less + and by 3 when there are 5 days or less but `quality` drops to 0 after the concert We have recently signed a supplier of conjured items. This requires an update to our system: - - "Conjured" items degrade in Quality twice as fast as normal items + - "Conjured" items degrade in `quality` twice as fast as normal items -Feel free to make any changes to the UpdateQuality method and add any new code -as long as everything still works correctly. However, do not alter the Item -class or Items property as those belong to the goblin in the corner who will +Feel free to make any changes to the `update_quality` method and add any new code +as long as everything still works correctly. However, do not alter the `Item` +class or `items` property as those belong to the goblin in the corner who will insta-rage and one-shot you as he doesn't believe in shared code ownership -(you can make the UpdateQuality method and Items property static if you like, +(you can make the `update_quality` method and `items` property static if you like, we'll cover for you). -Just for clarification, an item can never have its Quality increase above 50, -however "Sulfuras" is a legendary item and as such its Quality is 80 and it +Just for clarification, an item can never have its `quality` increase above 50, +however "Sulfuras" is a legendary item and as such its `quality` is 80 and it never alters. Source: