README.md in pennu-0.0.1 vs README.md in pennu-0.1
- old
+ new
@@ -1,9 +1,15 @@
# pennu: Penn students, get fed. #
-pennu is a simple Ruby library (soon to be gem) that allows you to easily retreive the menus of Penn dining halls.
+pennu is a simple Ruby gem that allows you to easily retreive the menus of Penn dining halls.
+## Installation ##
+
+pennu is hosted on rubygems, so installation is as simple as:
+
+```gem install pennu```
+
## How to use pennu ##
*This section may change as pennu is developed. As such, this section may not be fully accurate, but I will try to keep the instructions as current as possible.*
Running:
@@ -30,11 +36,11 @@
Hemispheres: Local Yogurts, Fresh Baked Bagels and Bread Bar, Assorted Pastriesand Desserts, Make your Own Waffle Bar, Ice Cream
Deli: Assorted Breads, Deli Meats and Cheeses made to order
Good 4 You: Tofu and Red Lentil Risotto, Roasted Eggplant, Balsamic Tomatoes
```
-Calling ``` hill.friday.dinner``` will yield a ``` String``` like the output above. The menu items are more accessible as a hash of titles (e.g. ```Kettles``` and items (e.g. ```Mushroom Barley and Chicken Tortilla Soup```). To get the menu as a hash, simple call ```to_hash```. Running:
+Calling ``` hill.friday.dinner``` will yield a ``` String``` like the output above. The menu items are more accessible as a hash of titles (e.g. ```Kettles```) and items (e.g. ```Mushroom Barley and Chicken Tortilla Soup```). To get the menu as a hash, simply call ```to_hash```. Running:
```ruby
puts hill.friday.dinner.to_hash.inspect
```
@@ -52,7 +58,6 @@
## Contributing ##
All contributions are welcome via pull request.
## TODO ##
-* Create gem
* More extensive testing
\ No newline at end of file