diff --git a/LICENSE.md b/LICENSE.md new file mode 100644 index 0000000..e0a5cc4 --- /dev/null +++ b/LICENSE.md @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2024 Marc Farra + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE 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. diff --git a/README.md b/README.md index 23f9d23..4f686a7 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,6 @@ -# FIDE Players Viewer +# ![Chess Icon](./docs/assets/board.png) FIDE Players API & Viewer -View the list of FIDE players and their ratings. The source of the data is the [FIDE website](https://ratings.fide.com/download.phtml). -Originally created for use for [Keshmat Chess School](https://keshmat.org/). +View the list of FIDE players and their ratings. Originally created for use for [Keshmat Chess School](https://keshmat.org/). ## Architecture @@ -10,7 +9,7 @@ Originally created for use for [Keshmat Chess School](https://keshmat.org/). - `index.html` is a simple HTML page that uses the API to display the list of players - The Datasette API is available at [https://fide-players.fly.dev/players](https://fide-players.fly.dev/players) - The HTML page is available at [https://kamicut.cc/fide-players/](https://kamicut.cc/fide-players/) -- TODO: A Github Action to update the data daily +- A Github Action is used to update the data weekly and deploy the API and HTML page ## Run locally @@ -42,3 +41,10 @@ Open the HTML page in a browser: ```bash open index.html ``` + +## Attributions + +- Data from [FIDE](https://ratings.fide.com/download.phtml) +- Icons Chess icons created by Andrejs Kirma - Flaticon + +# License diff --git a/docs/assets/board.png b/docs/assets/board.png new file mode 100644 index 0000000..0ac693a Binary files /dev/null and b/docs/assets/board.png differ diff --git a/index.html b/docs/index.html similarity index 83% rename from index.html rename to docs/index.html index 0115745..90c016c 100644 --- a/index.html +++ b/docs/index.html @@ -5,9 +5,16 @@ -
Use this tool to search for FIDE-rated chess players by name and country. Click on a player's row to view their profile on the FIDE ratings website.