|
@@ -1,34 +1,41 @@
|
|
|
-# [](#readme)<br>JokeAPI
|
|
|
+<!-- unholy HTML -->
|
|
|
+<div style="text-align: center;" align="center">
|
|
|
+ <h1>
|
|
|
+ <a href="#readme"><img src="https://sv443.net/cdn/jokeapi/icon_readme.png" width="120" height="120"></a><br>JokeAPI<br>
|
|
|
+ <h3>
|
|
|
+ > <a href="https://jokeapi.dev/" rel="noopener noreferrer">Documentation</a> • <a href="https://jokeapi.dev/#try-it" rel="noopener noreferrer">Try it out</a> • <a href="./changelog.md" rel="noopener noreferrer">Changelog</a> • <a href="https://dc.sv443.net/" rel="noopener noreferrer">Discord Server</a> <
|
|
|
+ </h3>
|
|
|
+ </h1><br>
|
|
|
+
|
|
|
+A free and open REST API that delivers consistently formatted jokes in JSON, XML, YAML, or plain text.
|
|
|
+Powerful filters allow you to get just the jokes you want - no sign-up needed. Comes with CORS support.
|
|
|
|
|
|
-### A REST API that serves uniformly and well formatted jokes and offers a great variety of filtering methods and response customization
|
|
|
-
|
|
|
-[](https://sv443.net/LICENSE)
|
|
|
-[](https://status.sv443.net/)
|
|
|
-[](https://github.com/Sv443-Network/JokeAPI/issues)
|
|
|
-
|
|
|
-[](https://github.com/Sv443-Network/JokeAPI/actions)
|
|
|
-[](https://snyk.io/test/github/Sv443-Network/JokeAPI)
|
|
|
-
|
|
|
-[](https://discord.gg/aBH4uRG)
|
|
|
-[](https://github.com/Sv443-Network/JokeAPI/stargazers)
|
|
|
+<br>
|
|
|
|
|
|
-<br><br>
|
|
|
+[](https://status.sv443.net/) [](https://snyk.io/test/github/Sv443-Network/JokeAPI) [](https://sv443.net/LICENSE)
|
|
|
+[](https://dc.sv443.net/) [](https://github.com/Sv443-Network/JokeAPI/issues) [](https://github.com/Sv443-Network/JokeAPI/stargazers)
|
|
|
|
|
|
-# [Documentation](https://jokeapi.dev/)
|
|
|
+</div>
|
|
|
|
|
|
-## [Try it out](https://jokeapi.dev/#try-it) • [Changelog](./changelog.md) • [Discord Server](https://dc.sv443.net/)
|
|
|
+<br>
|
|
|
|
|
|
-<br><br>
|
|
|
+> [!WARNING]
|
|
|
+> JokeAPI contains a very wide variety of jokes, some of which can be seen as quite offensive.
|
|
|
+> They can be reliably filtered out using the parameters [`?blacklistFlags`](https://jokeapi.dev/#flags-param) and [`?safe-mode`](https://jokeapi.dev/#safe-mode).
|
|
|
+> Still, use this API at your own risk!
|
|
|
|
|
|
-### 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!
|
|
|
+> [!NOTE]
|
|
|
+> Enjoying JokeAPI? It's free to use, but if you want to support the development, [please consider supporting the development.](https://github.com/sponsors/Sv443)
|
|
|
|
|
|
-### If you want to contribute to JokeAPI (code, jokes or translations), please refer to the [contributing guide.](./.github/Contributing.md)
|
|
|
+> [!NOTE]
|
|
|
+> If you want to contribute to JokeAPI (code, jokes or translations), please refer to the [contributing guide.](./.github/Contributing.md)
|
|
|
+> For code contributions, please refer to the repo at https://git.sv443.net/sv443/JokeAPI-v2
|
|
|
|
|
|
-<br><br>
|
|
|
+<br>
|
|
|
|
|
|
-# Community-made wrapper libraries:
|
|
|
+## Community-made wrapper libraries:
|
|
|
- <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>
|
|
|
-- <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/MichaelDark/jokeapi#readme"><img src="./docs/static/external/dart.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/the-codeboy/Jokes4J#readme"><img src="./docs/static/external/java.svg" width="16" height="16" /> Java (com.github.the-codeboy.Jokes4J)</a></b>
|
|
|
- <b><a href="https://github.com/EasyG0ing1/JavaJokesAPI#readme"><img src="./docs/static/external/java.svg" width="16" height="16" /> Java (com.simtechdata.jokeapi)</a></b>
|
|
@@ -36,13 +43,14 @@
|
|
|
- <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/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/IllusionMan1212/jokeapi-odin#readme"><img src="./docs/static/external/odin.svg" width="16" height="16" /> Odin</a></b>
|
|
|
+- <b><a href="https://github.com/JustPush-io/php-jokeapi#readme"><img src="./docs/static/external/php.svg" width="16" height="16" /> PHP</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/canarado/joketeller#readme"><img src="./docs/static/external/rust.svg" width="16" height="16" /> Rust</a></b>
|
|
|
- <b><a href="https://github.com/bitstep-ie/jokeapi#readme"><img src="./docs/static/external/typescript.svg" width="16" height="16" /> TypeScript</a></b>
|
|
|
|
|
|
<br>
|
|
|
|
|
|
-# Projects that use JokeAPI:
|
|
|
+## Some projects that use JokeAPI:
|
|
|
|
|
|
| Project | Author |
|
|
|
| -------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------- |
|
|
@@ -60,11 +68,6 @@
|
|
|
| [JokeAPI_ComputerCraft](https://github.com/Sv443-Network/JokeAPI_ComputerCraft) | [Sv443](https://github.com/Sv443) |
|
|
|
| [Dev Dad Jokes](https://github.com/jonathanbossenger/devdadjokes) | [Jonathan Bossenger](https://github.com/jonathanbossenger) |
|
|
|
|
|
|
-<br>
|
|
|
-
|
|
|
-Project submissions are paused for the foreseeable future.
|
|
|
-<!-- [Submit an issue](https://github.com/Sv443-Network/JokeAPI/issues/new/choose) and select `Dependent` to get your project added here -->
|
|
|
-
|
|
|
<!--
|
|
|
Old list-style dependents:
|
|
|
- [dozens Advices](https://github.com/ZephyrVentum/dozens-Advices) by [ZephyrVentum](https://github.com/ZephyrVentum)
|
|
@@ -81,7 +84,11 @@ Old list-style dependents:
|
|
|
- [JokeAPI_ComputerCraft](https://github.com/Sv443-Network/JokeAPI_ComputerCraft) by [Sv443](https://github.com/Sv443)
|
|
|
-->
|
|
|
|
|
|
-<br><br>
|
|
|
+<br><br><br><br>
|
|
|
+
|
|
|
+<div style="text-align: center;" align="center">
|
|
|
|
|
|
Made with ❤️ by [Sv443](https://github.com/Sv443) and [contributors](https://github.com/Sv443-Network/JokeAPI/graphs/contributors)
|
|
|
-Like JokeAPI? Please consider [supporting me](https://github.com/sponsors/Sv443)
|
|
|
+Like JokeAPI? Please consider [supporting the development](https://github.com/sponsors/Sv443)
|
|
|
+
|
|
|
+</div>
|