Update readmes

Author: man90es

README.md

@@ -1,31 +1,16 @@
 # Black Desert social REST API
-
-An unofficial JSON API server for Black Desert Online that gets guild and player data via scraping the official website.
-
-## API
-See [OpenAPI documentation](https://gitlab.com/man90/black-desert-social-rest-api/-/tree/master/doc/api/openapi.json).
+An unofficial REST API server for Black Desert Online community data.
 
 ## Projects using this API
-- [BDO Leaderboards](https://man90.gitlab.io/bdo-leader-boards): a web-based leaderboard application for Black Desert Online guilds.
-
+- [BDO Leaderboards](https://bdo.hemlo.cc/leaderboards/): a web-based leaderboard application for BDO guilds.
 
+## API routes
+The current version of API is v1. **v0 is no longer supported** and is not fully functional due to changes in the official BDO website.
+- The migration guide can be found [here](doc/migrationGuilde.md).
+- The v1 OpenAPI documentation can be found [here](https://gitlab.com/man90/black-desert-social-rest-api/-/tree/master/doc/api/openapi.json).
 
 ## Getting the binary
-### Prebuilt
-You can download prebuilt binaries [here](https://gitlab.com/man90/black-desert-social-rest-api/-/pipelines).
-
-### Building from source
-Prerequisites: <abbr title="Not tested on other platforms.">GNU/Linux</abbr>, Go >=1.15
-
-Command:
-```bash
-go build
-```
-
-By default, scraped results are cached in memory and stored for up to 2 hours, it helps to ease the pressure on BDO servers and speeds up the response time in some situations. If you don't want to cache scraped results (for example if you just want to create a dump or need extra fresh data), use this command instead:
-```bash
-go build -tags "cacheless"
-```
+You can either download prebuilt binaries from [here](https://gitlab.com/man90/black-desert-social-rest-api/-/pipelines) or build them yourself following [this guide](doc/buildingFromSource.md).
 
 ## Environment variables
 Catch requests on a specific port (8001 by default):
@@ -52,7 +37,7 @@ Flags override environment variables
 ```
 Use them like this:
 ```bash
-./black-desert-social-rest-api -proxy="http://192.168.0.0.1:8080" -cachettl=30
+./bdo-rest-api -proxy="http://192.168.0.0.1:8080" -cachettl=30
 ```
 
 ## Known bugs

doc/brokenStuff.md

@@ -1,19 +1,19 @@
 # Broken Stuff
-BDO website, where all the data is taken from, has a number of bugs, which are replicated by this API by design and, sadly, nothing can be done about it on my side.
+BDO website, where all the data is taken from, has a number of bugs, which are replicated by this API by design and, sadly, not much can be done about it.
 
 ## List of known bugs
-This is a list of bugs that I am aware of:
-1. When profile of one of a number of guilds is requested, another guild's profile is returned. (e.g. requesting the profile of VoS guild on EU returns the profile of Ocrana guild on EU).
-1. Opening some guild profiles returns a 404 page despite the fact that that guild exists. (e.g. Valiant guild on EU)
-2. Sometimes members who left the guild are still displayed as members for some time.
-3. Data is not updated immediately after it is updated in game.
+This is a list of bugs that either used to occur or still occur that I am aware of:
+1. When you request one guild, the server may return another guild.
+2. When you request a guild, the server may return a "not found" status despite the fact that that guild does exist.
+3. Members who left the guild are still displayed as members for some time.
+4. Data is not updated immediately after it is updated in game.
 
 ## Workarounds and tips
 List numbers match list numbers in the previous section:
-1. Check the name of the guild in the response. Is it the same as the one you requested?
-1. You can get some information like creation date, guild master's name and population by searching for guild instead of requesting its profile. Not much, but better than nothing.
-2. I believe maintenances remove "ghost members" from guilds. If you don't feel like waiting, request profiles of those players. Guild membership status in player profiles is more reliable, unless it's set to private.
-3. The lag is around a few hours, and you can only wait. This API may introduce additional lag (≤2 hours) in some cases, so if you need the most fresh data possible, consider disabling cache as it's described in the main README (I assume that you understand the consequences).
+1. If the response has a different guild name than the one you requested, it's a bug. See tip #2.
+2. You can get some information like creation date, guild master's name and population by searching for guild instead of requesting its profile. Not much, but it's better than nothing.
+3. I believe maintenances remove "ghost members" from guilds. If you don't feel like waiting, request profiles of those players. Guild membership status in player profiles is more reliable, unless it's set to private.
+4. The lag is around a few hours, and you can only wait. This API may introduce additional lag (≤2 hours) in some cases, so if you need the most fresh data possible, consider disabling cache as it's described in [building from source manual](./buildingFromSource.md).
 
 ## Contribute to this list
 If you found a bug on the original BDO website that affects this API and is not listed in this file, you can contribute by either:

doc/buildingFromSource.md

@@ -0,0 +1,12 @@
+# Building from source
+Prerequisites: <abbr title="Not tested on other platforms.">GNU/Linux</abbr>, Go >=1.15
+
+Command:
+```bash
+go build
+```
+
+By default, scraped results are cached in memory and stored for up to 2 hours. It helps to ease the pressure on BDO servers and speeds up the response time in some situations. If you don't want to cache scraped results (e.g., if you only want to create a dump or need the most fresh data), use this command instead:
+```bash
+go build -tags "cacheless"
+```