Improved docs & README

README.md

@@ -28,7 +28,15 @@ $ gem install etf2l
 
 ## Usage
 
-TODO: Write usage instructions here
+### Whitelists
+
+Fetch an array of whitelists currently used in the ETF2L:
+
+```ruby
+whitelists = Etf2l::API.whitelists
+whitelists.first.name #=> "ETF2L Ultiduo"
+whitelists.first.url  #=> "http://etf2l.org/configs/etf2l_whitelist_ultiduo.txt"
+```
 
 ## Contributing
 

lib/etf2l/api.rb

@@ -13,19 +13,20 @@ class API
     #
     # @return [Player] The requested player.
     # @example by ETF2L ID
-    #    API.player(10512)
+    #   API.player(10512)
     # @example by SteamID
-    #    API.player("STEAM_0:0:18721806")
+    #   API.player("STEAM_0:0:18721806")
     # @example by SteamID64
-    #    API.player(76561197997709340)
+    #   API.player(76561197997709340)
     def self.player(identifier)
       response = get("/player/#{identifier}")
       Player.new(response["player"])
     end
 
 
     # Returns an array of (currently used) whitelists.
-    #
+    # @example
+    #  API.whitelists
     # @return [Array<Whitelist>] an array of (currently used) whitelists.
     def self.whitelists
       response = get("/whitelists")

lib/etf2l/resources/whitelist.rb

@@ -1,5 +1,16 @@
 module Etf2l
+
+  # ETF2L whitelist.
   class Whitelist
+
+    # @!attribute [r] name
+    #   @return [String] name of the whitelist.
+    # @!attribute [r] filename
+    #   @return [String] local file name when used on a game server.
+    # @!attribute [r] last_change
+    #   @return [Time] timestamp of the last modification date.
+    # @!attribute [r] url
+    #   @return [String] URL to the whitelist file.
     attr_reader :name, :filename, :last_change, :url
 
     def initialize(attributes)