Update the README file

Author: man90es

README.md

@@ -1,16 +1,17 @@
-# Black Desert social REST API
-An unofficial REST API server for Black Desert Online community data.
+# BDO-REST-API
+A collector for Black Desert Online player in-game data that provides an unofficial REST API.
 
 ## Projects using this API
-- [BDO Leaderboards](https://bdo.hemlo.cc/leaderboards/): a web-based leaderboard application for BDO guilds.
+- [BDO Leaderboards](https://bdo.hemlo.cc/leaderboards/) ([GitHub](https://github.com/octoman90/BDO-Leaderboards)): web-based leaderboards for Black Desert Online.
 
-## 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
-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).
+## How to start using it
+There are two ways to use this API in your apps:
+1. https://bdo-rest-api.herokuapp.com/v1 is an instance that I host. Keep in mind that it may be slow to respond, and might just stop working one day. It's also rolling-release: if the API changes in the master branch on GitHub, this instance will reflect it immediately and your app may break. The API documentation can be viewed [here](https://gitlab.com/man90/black-desert-social-rest-api/-/tree/master/doc/api/openapi.json).
+2. Host it yourself. The server may cost some money, but the process is trivial. This approach will give you more stability and freedom. There are four easy steps to it:
+	1. Build the server from the source code following [this guide](doc/buildingFromSource.md) or download a prebuilt Linux binary from [here](https://gitlab.com/man90/black-desert-social-rest-api/-/pipelines).
+	2. Set the environment variables if you want. The list is in a section below.
+	3. Run the binary. Possible flags are described in a section below.
+	4. Use the API as described in the [documentation](https://gitlab.com/man90/black-desert-social-rest-api/-/tree/master/doc/api/openapi.json).
 
 ## Environment variables
 Catch requests on a specific port (8001 by default):
@@ -26,7 +27,7 @@ export PROXY="http://123.123.123.123:8080 http://124.124.124.124:8081"
 ```
 
 ## Flags
-Flags override environment variables
+These flags override environment variables.
 ```
 -cachettl int
 	Cache TTL in minutes (default 180)
@@ -41,4 +42,13 @@ Use them like this:
 ```
 
 ## Known bugs
-A vast majority of bugs comes from the original BDO website, where data is taken from. You can find a list of known bugs and workarounds [here](doc/brokenStuff.md).
+There is a number of bugs that the official BDO website has. This collector does not do anything about them for the sake of simplicity, so your apps may need to use the [workarounds](doc/brokenStuff.md).
+
+## API migration
+There used to be a v0 version that is no longer supported, so if you use it, use the  [migration guide](doc/migrationGuilde.md).
+
+## Contributing
+Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
+
+## License
+[MIT](LICENSE)