aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorArda Serdar Pektezol <1669855+pektezol@users.noreply.github.com>2023-07-03 18:01:15 +0300
committerArda Serdar Pektezol <1669855+pektezol@users.noreply.github.com>2023-07-03 18:01:15 +0300
commitbe4efc7d09d3ebbe63c4b4d7763341189545ad3c (patch)
treee49dc0773c58c0ef66ab2da3079d701579ff36ae /README.md
parentfeat: parser for getting portal and tick count (#42) (diff)
downloadlphub-be4efc7d09d3ebbe63c4b4d7763341189545ad3c.tar.gz
lphub-be4efc7d09d3ebbe63c4b4d7763341189545ad3c.tar.bz2
lphub-be4efc7d09d3ebbe63c4b4d7763341189545ad3c.zip
docs: update readme
Former-commit-id: a810590f30535b528e27eb45d836bf7b5af9c11d
Diffstat (limited to 'README.md')
-rw-r--r--README.md34
1 files changed, 31 insertions, 3 deletions
diff --git a/README.md b/README.md
index 2063667..5a44f82 100644
--- a/README.md
+++ b/README.md
@@ -1,6 +1,12 @@
1# Portal 2 Least Portals Database 1# Portal 2 Least Portals Hub
2 2
3This project is work in progress. 3## About LPHUB
4
5Least Portals Hub (LPHUB) is a community-driven platform that aims to gather knowledge and competition of the Portal 2 Least Portals (LP) category in one place. LPHUB is dedicated to bringing together users who love the challenge of LP, where the goal is to complete a level using the fewest number of portals possible that is placed by the player.
6
7Our comprehensive map library contains detailed, wiki-style information for maps from Portal 2 and their mods, including strategies and routes for achieving specific portal counts. These guides are designed to assist players of all levels in improving their skills, understanding the game's mechanics better, and finding innovative ways to lower their portal usage.
8
9In addition, we host a leaderboard section for each map where users can compare their accomplishments and compete for having the lowest amount of portals possible. Users can upload their records, along with demo proof in order to get on to the leaderboards.
4 10
5## Project Team 11## Project Team
6 12
@@ -9,6 +15,10 @@ This project is work in progress.
9* [@Nidboj132](https://github.com/Nidboj132) - Frontend 15* [@Nidboj132](https://github.com/Nidboj132) - Frontend
10* [@Oryn](https://github.com/Oryn-Goia) - Subject Expert 16* [@Oryn](https://github.com/Oryn-Goia) - Subject Expert
11 17
18## Special Thanks
19
20* [@UncraftedName](https://github.com/UncraftedName) - For providing the parser that retrieves total portal count and elapsed time from the CM counter.
21
12## Documentation 22## Documentation
13 23
14Full documentation can be found at https://lp.ardapektezol.com/api/v1/ 24Full documentation can be found at https://lp.ardapektezol.com/api/v1/
@@ -19,4 +29,22 @@ This project is licensed under the GNU General Public License v2.0 - see the [LI
19 29
20## Contact 30## Contact
21 31
22If you have any questions or feedback, please feel free to contact us at our [Discord](https://discord.gg/xq6TySyA4c). \ No newline at end of file 32If you have any questions or feedback, please feel free to contact us at our [Discord](https://discord.gg/xq6TySyA4c).
33
34## Support
35
36If you want to support the creator, you can do so by using GitHub sponsorships by [clicking here](https://github.com/sponsors/pektezol).
37
38## Disclaimer
39
40This project, "Portal 2 Least Portals Hub" (hereafter referred to as "LPHUB"), is an unofficial community-driven resource providing strategies, routes, leaderboards, and other information related to the "Least Portals" category of the game "Portal 2". LPHUB is not affiliated with or endorsed by the creators, developers, or publishers of "Portal 2", including but not limited to Valve Corporation.
41
42The strategies, routes, leaderboard entries, and other information presented on LPHUB are provided by members of the community and are not guaranteed to be correct, accurate, or applicable to all versions or modes of "Portal 2". Users are encouraged to verify information and submit corrections or additions as necessary.
43
44Leaderboard entries must include demo proof, which is subject to review by LPHUB administrators and moderators. While every effort is made to ensure the integrity of the leaderboard, LPHUB cannot guarantee the authenticity or accuracy of any submitted record or demo.
45
46The source code for LPHUB is licensed under the GNU General Public License version 2.0 (GPL-2.0). By using LPHUB, you agree to abide by the terms and conditions of this license. The source code is provided "as is", without warranty of any kind, express or implied, including but not limited to the warranties of merchantability, fitness for a particular purpose, and noninfringement. In no event shall the authors or copyright holders be liable for any claim, damages, or other liability, whether in an action of contract, tort, or otherwise, arising from, out of, or in connection with the software or the use or other dealings in the software.
47
48Your use of LPHUB is at your own risk. LPHUB and its administrators and moderators disclaim all liability for any damages, whether direct, indirect, incidental, or consequential, that may result from your use of LPHUB or the strategies, routes, or other information provided therein.
49
50By using LPHUB, you acknowledge that you have read and understood this disclaimer and agree to its terms. \ No newline at end of file