docs: readme overhaul

Author: null8626

README.md

@@ -1,59 +1,123 @@
-# [Top.gg](https://top.gg) Ruby
+# Top.gg Ruby SDK
 
-The Top.gg Ruby SDK is a lighweight package, that allows you
-to fetch data from the top.gg api and post data such as statistics to the website.
+The community-maintained Ruby library for Top.gg.
 
-It provides you with numerous methods to interact with the API.
+## Installation
 
-## Dependencies
+```sh
+$ gem install topgg
+```
 
-- Ruby
+## Setting up
 
-## Installation
+```rb
+require "topgg"
 
-```bash
+client = Topgg.new(ENV["TOPGG_TOKEN"])
+```
 
-gem install topgg
+## Usage
 
+### Getting a bot
+
+```rb
+bot = client.get_bot("264811613708746752")
 ```
 
-## Note
+### Getting several bots
 
-You require a Token to interact with the Api.
-The token can be found at `https://top.gg/bot/[YOUR_BOT_ID]/webhooks`
+```rb
+bots = client.get_bots({ sort: "date", limit: 50, offset: 0 })
 
-## Example
+for bot in bots.results do
+  puts bot.username
+```
 
-Here's a straightforward example of how to request data with the wrapper.
+### Getting your bot's voters
 
-```ruby
-require "topgg"
+#### First page
 
-client = Topgg.new("AUTH_TOKEN", "BOTID")
+```rb
+voters = client.get_votes
 
-client.get_bot("1234").avatar
-# returns
-# "https://cdn.discordapp.com/avatars/661200758510977084/4354318859c319c7ca39753260fdd350.png?size=4096"
+for voter in voters.results do
+  puts voter.username
 ```
 
-### Auto Posting
+#### Subsequent pages
 
-The library provides you with autoposting functionality, and autoposts at an interval of 15 minutes.
-Here's how you can use it
+```rb
+voters = client.get_votes(2)
 
-```ruby
-require "topgg"
+for voter in voters.results do
+  puts voter.username
+```
+
+### Check if a user has voted for your bot
+
+```rb
+has_voted = client.voted?("661200758510977084")
+```
+
+### Getting your bot's server count
+
+```rb
+stats = client.get_stats
+server_count = client.server_count
+```
+
+### Posting your bot's server count
+
+```rb
+client.post_stats(bot.server_count)
+```
+
+### Automatically posting your bot's server count every few minutes
+
+For Discordrb:
+
+```rb
 require "discordrb"
 
-bot = Discordrb::Bot.new token: "TOKEN"
+bot = Discordrb::Bot.new(token: env["BOT_TOKEN"], intents: [:servers])
 
-client = Topgg.new("AUTH_TOKEN", "BOTID")
 bot.ready do |event|
-  client.auto_post_stats(bot) # The discordrb bot client.
+  client.auto_post_stats(bot)
+  
+  puts "Bot is now ready!"
 end
+
 bot.run
 ```
 
-# Documentation
+### Checking if the weekend vote multiplier is active
+
+```rb
+is_weekend = client.is_weekend?
+```
+
+### Generating widget URLs
+
+#### Large
+
+```rb
+widget_url = Dbl::Widget.large(:discord_bot, "574652751745777665")
+```
+
+#### Votes
+
+```rb
+widget_url = Dbl::Widget.votes(:discord_bot, "574652751745777665")
+```
+
+#### Owner
+
+```rb
+widget_url = Dbl::Widget.owner(:discord_bot, "574652751745777665")
+```
+
+#### Social
 
-Check out the api reference [here](https://rubydoc.info/gems/topgg/)
+```rb
+widget_url = Dbl::Widget.social(:discord_bot, "574652751745777665")
+```