Skip to content

Commit

Permalink
fix(docs): Update social badges to markdown
Browse files Browse the repository at this point in the history
  • Loading branch information
TheOnlyWayUp committed Feb 2, 2024
1 parent 2457e6a commit 063cbe9
Show file tree
Hide file tree
Showing 4 changed files with 46 additions and 6 deletions.
5 changes: 3 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,8 +34,9 @@ The `wattpad` package is an asynchronous wrapper around the Wattpad User API.
<br>


<iframe src="https://ghbtns.com/github-btn.html?user=TheOnlyWayUp&type=follow&count=true&size=large" frameborder="0" scrolling="0" width="230" height="30" title="GitHub"></iframe>
<iframe src="https://ghbtns.com/github-btn.html?user=TheOnlyWayUp&repo=Wattpad-Py&type=watch&count=true&size=large" frameborder="0" scrolling="0" width="170" height="30" title="GitHub"></iframe>
![Follow Badge](https://img.shields.io/badge/-%40TheOnlyWayUp-blue?style=for-the-badge&logo=github&logoColor=green&label=Follow&link=https%3A%2F%2Fgithub.com%2FTheOnlyWayUp)
![Star Badge](https://img.shields.io/badge/-Wattpad--Py-orange?style=for-the-badge&logoColor=green&label=Star%20%E2%AD%90&link=https%3A%2F%2Fgithub.com%2FTheOnlyWayUp%2FWattpad-Py)


<br>

Expand Down
14 changes: 13 additions & 1 deletion docs/memory-efficiency.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,10 @@
"\n",
"This package strives to be resource efficient. This is done through the implementation of:\n",
"- The Singleton Design Pattern\n",
"- Caching for HTTP Requests"
"- Caching for HTTP Requests\n",
"\n",
"![Follow Badge](https://img.shields.io/badge/-%40TheOnlyWayUp-blue?style=for-the-badge&logo=github&logoColor=green&label=Follow&link=https%3A%2F%2Fgithub.com%2FTheOnlyWayUp) \n",
"![Star Badge](https://img.shields.io/badge/-Wattpad--Py-orange?style=for-the-badge&logoColor=green&label=Star%20%E2%AD%90&link=https%3A%2F%2Fgithub.com%2FTheOnlyWayUp%2FWattpad-Py)\n"
]
},
{
Expand Down Expand Up @@ -1009,10 +1012,19 @@
"cell_type": "markdown",
"metadata": {},
"source": [
"![Follow Badge](https://img.shields.io/badge/-%40TheOnlyWayUp-blue?style=for-the-badge&logo=github&logoColor=green&label=Follow&link=https%3A%2F%2Fgithub.com%2FTheOnlyWayUp) \n",
"![Star Badge](https://img.shields.io/badge/-Wattpad--Py-orange?style=for-the-badge&logoColor=green&label=Star%20%E2%AD%90&link=https%3A%2F%2Fgithub.com%2FTheOnlyWayUp%2FWattpad-Py)\n",
"\n",
"\n",
"<div align=\"center\">\n",
" <p>TheOnlyWayUp © 2024</p>\n",
"</div>\n"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": []
}
],
"metadata": {
Expand Down
20 changes: 17 additions & 3 deletions docs/quickstart.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,14 @@
"Let's hit the ground running by briefly describing all the functions in the library."
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"![Follow Badge](https://img.shields.io/badge/-%40TheOnlyWayUp-blue?style=for-the-badge&logo=github&logoColor=green&label=Follow&link=https%3A%2F%2Fgithub.com%2FTheOnlyWayUp) \n",
"![Star Badge](https://img.shields.io/badge/-Wattpad--Py-orange?style=for-the-badge&logoColor=green&label=Star%20%E2%AD%90&link=https%3A%2F%2Fgithub.com%2FTheOnlyWayUp%2FWattpad-Py)\n"
]
},
{
"cell_type": "markdown",
"metadata": {},
Expand Down Expand Up @@ -1115,20 +1123,26 @@
"source": [
"---\n",
"\n",
"Extra reading:\n",
"- https://docs.python.org/3/library/asyncio-task.html\n",
"\n",
"That's all! If you need help, look [here](https://github.com/TheOnlyWayUp/Wattpad-Py#support)."
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"![Follow Badge](https://img.shields.io/badge/-%40TheOnlyWayUp-blue?style=for-the-badge&logo=github&logoColor=green&label=Follow&link=https%3A%2F%2Fgithub.com%2FTheOnlyWayUp) \n",
"![Star Badge](https://img.shields.io/badge/-Wattpad--Py-orange?style=for-the-badge&logoColor=green&label=Star%20%E2%AD%90&link=https%3A%2F%2Fgithub.com%2FTheOnlyWayUp%2FWattpad-Py)\n",
"\n",
"\n",
"<div align=\"center\">\n",
" <p>TheOnlyWayUp © 2024</p>\n",
"</div>\n"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": []
}
],
"metadata": {
Expand Down
13 changes: 13 additions & 0 deletions docs/sync-and-async.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,10 @@
"\n",
"`wattpad` is an *asynchronous* package. That means, you need to use the `async` and `await` keywords to use the package.\n",
"\n",
"![Follow Badge](https://img.shields.io/badge/-%40TheOnlyWayUp-blue?style=for-the-badge&logo=github&logoColor=green&label=Follow&link=https%3A%2F%2Fgithub.com%2FTheOnlyWayUp) \n",
"![Star Badge](https://img.shields.io/badge/-Wattpad--Py-orange?style=for-the-badge&logoColor=green&label=Star%20%E2%AD%90&link=https%3A%2F%2Fgithub.com%2FTheOnlyWayUp%2FWattpad-Py)\n",
"\n",
"\n",
"## What is Async?\n",
"\n",
"A simple analogy: You're a painter who has to deliver 30 painted pots by the end of the day. Each pot takes fifteen minutes to paint, and another 45 to dry. That's an hour in total.\n",
Expand Down Expand Up @@ -115,10 +119,19 @@
"cell_type": "markdown",
"metadata": {},
"source": [
"![Follow Badge](https://img.shields.io/badge/-%40TheOnlyWayUp-blue?style=for-the-badge&logo=github&logoColor=green&label=Follow&link=https%3A%2F%2Fgithub.com%2FTheOnlyWayUp) \n",
"![Star Badge](https://img.shields.io/badge/-Wattpad--Py-orange?style=for-the-badge&logoColor=green&label=Star%20%E2%AD%90&link=https%3A%2F%2Fgithub.com%2FTheOnlyWayUp%2FWattpad-Py)\n",
"\n",
"\n",
"<div align=\"center\">\n",
" <p>TheOnlyWayUp © 2024</p>\n",
"</div>\n"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": []
}
],
"metadata": {
Expand Down

0 comments on commit 063cbe9

Please sign in to comment.