Misc readme changes

README.md

@@ -9,7 +9,7 @@
   <img alt="license" src="https://img.shields.io/discord/796790757947867156?color=4166f5&label=discord&style=flat-square" />
 </a> 
 
-A versatile API facade for the Hypixel Auction API written in Rust. The entire auction house is fetched with NBT parsing and inserted into a PostgreSQL database in **less than a second** every minute with low memory usage (varies depending on enabled features, network speed, hardware, and latency of the Hypixel API)! You can query by auction UUID, auctioneer, end time, item name, item tier, item id, price, enchants, bin and bids. You can sort by the item's bin / starting price. You can track the average price of each unique pet-level-rarity combination. You can track the lowest prices of all bins. It also can track new bins that are at least one million lower than previous bins. It can track the average auction and average bin prices and sales for up to seven days with custom 'averaging methods'.
+A versatile API facade for the Hypixel Auction API written in Rust. The entire auction house is fetched every minute with NBT parsing and inserted into a PostgreSQL database in **less than a second** and with low memory usage (varies depending on enabled features, network speed, hardware, and latency of the Hypixel API)! You can query by auction UUID, auctioneer, end time, item name, item tier, item id, price, enchants, bin and bids. You can sort by the item's bin / starting price. You can track the average price of each unique pet-level-rarity combination. You can track the lowest prices of all bins. It also can track new bins that are at least one million lower than previous bins. It can track the average auction and average bin prices and sales for up to seven days with custom 'averaging methods'.
 
 ## Set Up
 ### Prerequisites
@@ -46,8 +46,8 @@ A versatile API facade for the Hypixel Auction API written in Rust. The entire a
 - `/average`
 - `/query_items`
 
-### Docs & Examples
-- See docs and examples [here](https://github.com/kr45732/rust-query-api/blob/main/examples/examples.md)
+### Documentation & Examples
+- See documentation and examples [here](https://github.com/kr45732/rust-query-api/blob/main/docs/docs.md)
 
 ## Free Hosting
 ### Deploy On Railway
@@ -67,5 +67,5 @@ Steps to deploy on [Gigalixir](https://gigalixir.com/):
 The free tier of [Supabase](https://supabase.com/) is a great option with with plenty of storage and good performance.
 
 ## Todo
-- Better documentation & more examples
-- Improve underbin
+- Improve underbin
+- Improve speed of database transactions

examples/examples.md → docs/docs.md

@@ -1,4 +1,4 @@
-# Docs
+# Documentation
 ## Query
 - `key` - key to access the API
 - `query` - raw SQL to be executed. Requires the admin key
@@ -42,34 +42,34 @@
 - `key` - key to access the API
 
 # Examples
-### [example_1.json](https://github.com/kr45732/rust-query-api/blob/main/examples/example_1.json)
+### [example_1.json](https://github.com/kr45732/rust-query-api/blob/main/docs/example_1.json)
 - Request: /query?key=KEY&bin=true&item_id=POWER_WITHER_CHESTPLATE&tier=MYTHIC&item_name=%✪✪✪✪✪%&sort=ASC&limit=50
 - Meaning: find the cheapest 50 bins where the item id is POWER_WITHER_CHESTPLATE (Necron's chestplate), the tier is mythic, and has 5 stars. Sort by ascending bin price
 
-### [example_2.json](https://github.com/kr45732/rust-query-api/blob/main/examples/example_2.json)
+### [example_2.json](https://github.com/kr45732/rust-query-api/blob/main/docs/example_2.json)
 - Request: /pets?key=KEY&query=[LVL_100]_WITHER_SKELETON_LEGENDARY,[LVL_80]_BAL_EPIC,[LVL_96]_ENDER_DRAGON_EPIC_TB
 - Meaning: get the average pet prices for a level 100 legendary wither skeleton, a level 80 epic bal, and a level 96 epic ender dragon (tier boosted from epic to legendary)
 
-### [example_3.json](https://github.com/kr45732/rust-query-api/blob/main/examples/example_3.json)
+### [example_3.json](https://github.com/kr45732/rust-query-api/blob/main/docs/example_3.json)
 - Request /lowestbin?key=KEY
 - Meaning: get all lowest bins
 
-### [example_4.json](https://github.com/kr45732/rust-query-api/blob/main/examples/example_4.json)
+### [example_4.json](https://github.com/kr45732/rust-query-api/blob/main/docs/example_4.json)
 - Request /underbin?key=KEY
 - Meaning: get all new bins that make at least one million in profit compared to the lowest bin of the previous API update. Experimental and still being improved
 
-### [example_5.json](https://github.com/kr45732/rust-query-api/blob/main/examples/example_5.json)
+### [example_5.json](https://github.com/kr45732/rust-query-api/blob/main/docs/example_5.json)
 - Request /average_auction?key=KEY&time=1647830293999&step=60
 - Meaning: get average auction prices from the unix timestamp 1647830293999 to the present. Average sales by hour
 
-### [example_6.json](https://github.com/kr45732/rust-query-api/blob/main/examples/example_6.json)
+### [example_6.json](https://github.com/kr45732/rust-query-api/blob/main/docs/example_6.json)
 - Request /average_bin?key=KEY&time=1647830293999&step=60
 - Meaning: get average auction bin from the unix timestamp 1647830293999 to the present. Average sales by hour
 
-### [example_7.json](https://github.com/kr45732/rust-query-api/blob/main/examples/example_7.json)
+### [example_7.json](https://github.com/kr45732/rust-query-api/blob/main/docs/example_7.json)
 - Request /average?key=KEY&time=1647830293999&step=60
 - Meaning: get the combined average auctions and average bins from the unix timestamp 1647830293999 to the present. Average sales by hour
 
-### [example_8.json](https://github.com/kr45732/rust-query-api/blob/main/examples/example_8.json)
+### [example_8.json](https://github.com/kr45732/rust-query-api/blob/main/docs/example_8.json)
 - Request /query_items?key=KEY
 - Meaning: get a list of all current unique auction names