Browse Source

docs: update readme

Sv443 5 months ago
parent
commit
cf3e9c79bb
1 changed files with 38 additions and 36 deletions
  1. 38 36
      README.md

+ 38 - 36
README.md

@@ -1,61 +1,67 @@
-<div align="center" style="text-align:center">
-
 # [![icon](https://sv443.net/cdn/jokeapi/icon_readme.png)](#readme)<br>JokeAPI
+
 ### A REST API that serves uniformly and well formatted jokes and offers a great variety of filtering methods and response customization
+
 [![GitHub](https://img.shields.io/github/license/Sv443/JokeAPI)](https://sv443.net/LICENSE)
 [![Uptime / 7 Days](https://img.shields.io/uptimerobot/ratio/7/m784261094-bff76b959ebb8fc39f7eb2d0)](https://status.sv443.net/)
 [![Open Issues](https://img.shields.io/github/issues/Sv443/JokeAPI)](https://github.com/Sv443/JokeAPI/issues)
-  
+
 [![Actions Status](https://github.com/Sv443/JokeAPI/workflows/build/badge.svg)](https://github.com/Sv443/JokeAPI/actions)
 [![Known Vulnerabilities](https://snyk.io/test/github/Sv443/JokeAPI/badge.svg)](https://snyk.io/test/github/Sv443/JokeAPI)
-  
+
 [![Discord](https://img.shields.io/discord/565933531214118942)](https://discord.gg/aBH4uRG)
 [![GitHub stars](https://img.shields.io/github/stars/Sv443/JokeAPI?style=social)](https://github.com/Sv443/JokeAPI/stargazers)
 
 <br><br>
 
 # [Documentation](https://jokeapi.dev/)
-## [Try it out](https://jokeapi.dev/#try-it) &bull; [Changelog](./changelog.md) &bull; [Discord Server](https://dc.sv443.net/)
 
+## [Try it out](https://jokeapi.dev/#try-it) &bull; [Changelog](./changelog.md) &bull; [Discord Server](https://dc.sv443.net/)
 
-</div>
 <br><br>
 
-### Note: due to the different types of humor, JokeAPI contains a wide variety of jokes, of which some are very offensive. They can be filtered out, but use this API at your own risk!
-### If you want to contribute to JokeAPI (code, jokes or translations), please read the [contributing guide.](./.github/Contributing.md)
-### Want to know how JokeAPI works? The [developer documentation](https://github.com/Sv443/JokeAPI/tree/version/2.4.0/dev/docs/home.md#readme) (work in progress) explains it.
+### Note: due to the different types of humor, JokeAPI contains a wide variety of jokes, of which some are very offensive. They can be filtered out using the `?blacklistFlags` or `?safe-mode` parameters, but use this API at your own risk!
 
-<br><br>
+### If you want to contribute to JokeAPI (code, jokes or translations), please refer to the [contributing guide.](./.github/Contributing.md)
 
-# Official API Wrappers:
-- <b><a href="https://github.com/canarado/sv443_jokeapi_wrapper#readme"><img src="./docs/static/external/rust.svg" width="16" height="16"> Rust</a></b> (outdated)
-- <b><a href="https://github.com/thenamesweretakenalready/Sv443s-JokeAPI-Python-Wrapper#readme"><img src="./docs/static/external/python.svg" width="16" height="16"> Python</a></b>
-- <b><a href="https://github.com/sahithyandev/sv443-joke-api-js-wrapper#readme"><img src="./docs/static/external/nodejs.svg" width="16" height="16"> Node.js</a></b> (incomplete)
-- <b><a href="https://github.com/Icelain/jokeapi#readme"><img src="./docs/static/external/golang.svg" width="16" height="16"> Go</a></b>
+<br><br>
 
+# Community-made wrapper libraries:
+-   <b><a href="https://github.com/canarado/joketeller#readme"><img src="./docs/static/external/rust.svg" width="16" height="16" /> Rust</a></b>
+-   <b><a href="https://github.com/thenamesweretakenalready/Sv443s-JokeAPI-Python-Wrapper#readme"><img src="./docs/static/external/python.svg" width="16" height="16" /> Python</a></b>
+-   <b><a href="https://github.com/sahithyandev/sv443-joke-api-js-wrapper#readme"><img src="./docs/static/external/nodejs.svg" width="16" height="16" /> Node.js</a></b>
+-   <b><a href="https://github.com/MichaelDark/jokeapi#readme"><img src="./docs/static/external/dartlang.svg" width="16" height="16" /> Dart</a></b>
+-   <b><a href="https://github.com/Icelain/jokeapi#readme"><img src="./docs/static/external/golang.svg" width="16" height="16" /> Go</a></b>
+-   <b><a href="https://github.com/khurozov/jokeapi-java#readme"><img src="./docs/static/external/java.svg" width="16" height="16" /> Java (com.simtechdata.jokeapi)</a></b>
+-   <b><a href="https://github.com/khurozov/jokeapi-java#readme"><img src="./docs/static/external/java.svg" width="16" height="16" /> Java (uz.khurozov.jokeapi-java)</a></b>
+-   <b><a href="https://github.com/ethauvin/jokeapi#readme"><img src="./docs/static/external/kotlin.svg" width="16" height="16" /><img src="./docs/static/external/java.svg" width="16" height="16" /><img src="./docs/static/external/android.svg" width="16" height="16" /> Kotlin, Java & Android</a></b>
+-   <b><a href="https://github.com/the-codeboy/Jokes4J#readme"><img src="./docs/static/external/java.svg" width="16" height="16" /> Jokes4J</a></b>
+-   <b><a href="https://github.com/DanBuxton/JokeAPI-CS-Wrapper#readme"><img src="./docs/static/external/csharp.svg" width="16" height="16" /> C#</a></b>
 
 <br>
 
 # Projects that use JokeAPI:
-| Project | Author |
-| --- | --- |
-| [dozens Advices](https://github.com/ZephyrVentum/dozens-Advices) | [ZephyrVentum](https://github.com/ZephyrVentum) |
-| [Shadow](https://github.com/QGIsK/Shadow) | [QGIsK](https://github.com/QGIsK) |
-| [Jokepy](https://github.com/aksty/Jokepy) | [aksty](https://github.com/aksty) |
-| [Dark1](https://github.com/whiteadi/Dark1) | [whiteadi](https://github.com/whiteadi) |
-| [Prejudice Networks](https://github.com/LiamTownsley/Prejudice-Networks) | [Liam Townsley](https://github.com/LiamTownsley) |
-| [https://irshad.ml/humour.html](https://irshad.ml/humour.html) | [draco-malfoy](https://github.com/draco-malfoy) |
-| [Random Joke Generator with Flutter](https://github.com/variousnabil/Random-Joke-Generator-with-Flutter) | [variousnabil](https://github.com/variousnabil) |
-| [comma](https://thatcopy.pw/comma) | [ThatCopy](https://github.com/ThatCopy) |
-| [Joke Teller](https://github.com/AlHood77/Joke_Teller) | [AlHood77](https://github.com/AlHood77) |
-| [Jokes plugin for Craft CMS 3.x](https://github.com/remcoov/jokes) | [remcoov](https://github.com/remcoov) |
-| [PoshBot.Joker](https://github.com/ToastIT-dev/PoshBot.Joker) | [ToastIT-dev](https://github.com/ToastIT-dev) |
-| [JokeAPI_ComputerCraft](https://github.com/Sv443/JokeAPI_ComputerCraft) | [Sv443](https://github.com/Sv443) |
-| [Dev Dad Jokes](https://github.com/jonathanbossenger/devdadjokes) | [Jonathan Bossenger](https://github.com/jonathanbossenger) |
+
+| Project                                                                                                  | Author                                                     |
+| -------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------- |
+| [dozens Advices](https://github.com/ZephyrVentum/dozens-Advices)                                         | [ZephyrVentum](https://github.com/ZephyrVentum)            |
+| [Shadow](https://github.com/QGIsK/Shadow)                                                                | [QGIsK](https://github.com/QGIsK)                          |
+| [Jokepy](https://github.com/aksty/Jokepy)                                                                | [aksty](https://github.com/aksty)                          |
+| [Dark1](https://github.com/whiteadi/Dark1)                                                               | [whiteadi](https://github.com/whiteadi)                    |
+| [Prejudice Networks](https://github.com/LiamTownsley/Prejudice-Networks)                                 | [Liam Townsley](https://github.com/LiamTownsley)           |
+| [https://irshad.ml/humour.html](https://irshad.ml/humour.html)                                           | [draco-malfoy](https://github.com/draco-malfoy)            |
+| [Random Joke Generator with Flutter](https://github.com/variousnabil/Random-Joke-Generator-with-Flutter) | [variousnabil](https://github.com/variousnabil)            |
+| [comma](https://thatcopy.pw/comma)                                                                       | [ThatCopy](https://github.com/ThatCopy)                    |
+| [Joke Teller](https://github.com/AlHood77/Joke_Teller)                                                   | [AlHood77](https://github.com/AlHood77)                    |
+| [Jokes plugin for Craft CMS 3.x](https://github.com/remcoov/jokes)                                       | [remcoov](https://github.com/remcoov)                      |
+| [PoshBot.Joker](https://github.com/ToastIT-dev/PoshBot.Joker)                                            | [ToastIT-dev](https://github.com/ToastIT-dev)              |
+| [JokeAPI_ComputerCraft](https://github.com/Sv443/JokeAPI_ComputerCraft)                                  | [Sv443](https://github.com/Sv443)                          |
+| [Dev Dad Jokes](https://github.com/jonathanbossenger/devdadjokes)                                        | [Jonathan Bossenger](https://github.com/jonathanbossenger) |
 
 <br>
 
-[Submit an issue](https://github.com/Sv443/JokeAPI/issues/new/choose) and select `Dependent` to get your project added here
+Project submissions are paused for the foreseeable future.
+<!-- [Submit an issue](https://github.com/Sv443/JokeAPI/issues/new/choose) and select `Dependent` to get your project added here -->
 
 <!--
 Old list-style dependents:
@@ -73,11 +79,7 @@ Old list-style dependents:
 - [JokeAPI_ComputerCraft](https://github.com/Sv443/JokeAPI_ComputerCraft) by [Sv443](https://github.com/Sv443)
 -->
 
-
 <br><br>
-<div align="center" style="text-align:center">
 
-Made with ❤️ by [Sv443](https://github.com/Sv443)  
+Made with ❤️ by [Sv443](https://github.com/Sv443) and [contributors](https://github.com/Sv443/JokeAPI/graphs/contributors)  
 Like JokeAPI? Please consider [supporting me](https://github.com/sponsors/Sv443)
-
-</div>