From eba726cdac5d33ffbb1cfab0ab57ea874340c9bd Mon Sep 17 00:00:00 2001
From: Rafael Franco <oi@rafaelfranco.com>
Date: Tue, 16 May 2023 09:30:12 -0300
Subject: [PATCH] chore: update README.md

---
 README.md    |  17 +++++++-
 duo.svg      | 119 +++++++++++++++++++++++++++++++++++++++++++++++++++
 package.json |   2 +-
 3 files changed, 136 insertions(+), 2 deletions(-)
 create mode 100644 duo.svg

diff --git a/README.md b/README.md
index 7720bd5..2c32d99 100644
--- a/README.md
+++ b/README.md
@@ -2,4 +2,19 @@
 
 [![Keep my Duolingo streak](https://github.com/rfoel/duolingo/actions/workflows/streak-keeper.yml/badge.svg?branch=main)](https://github.com/rfoel/duolingo/actions/workflows/streak-keeper.yml)
 
-Script to farm Duolingo XP. Never get demoted again!
+<img src="duo.svg" width="128px"/>
+
+Streak keeper and XP farm for Duolingo. Never get demoted again!
+
+## Streak Keeper
+
+This project uses GitHub Actions scheduled workflow to keep your streak alive. The workflow can be viewed [here](.github/workflows/streak-keeper.yml).
+
+## Study
+
+This repository can also "study" lessons for you. This will give you XP so you won't get demoted never again! This workflow uses [workflow_dispatch](https://docs.github.com/en/actions/using-workflows/events-that-trigger-workflows#workflow_dispatch) to trigger the study session. You can choose the number of lessons to be done. The workflow can be viewed [here](.github/workflows/study.yml).
+
+## Caveats
+
+- This project won't help with your daily or friend quests, it can only earn XP to move up the league rank;
+- This project won't do real lessons or stories, only practices, so it won't affect your learning path;
diff --git a/duo.svg b/duo.svg
new file mode 100644
index 0000000..38d5523
--- /dev/null
+++ b/duo.svg
@@ -0,0 +1,119 @@
+<svg viewBox="0 0 163 156" fill="none" xmlns="http://www.w3.org/2000/svg">
+  <path
+    fill-rule="evenodd"
+    clip-rule="evenodd"
+    d="M52.0372 138.686C52.0372 134.56 55.3951 131.195 59.5112 131.195H71.2097C75.3258 131.195 78.6836 134.56 78.6836 138.686C78.6836 142.812 75.3258 146.177 71.2097 146.177H59.5112C55.3951 146.177 52.0372 142.812 52.0372 138.686Z"
+    fill="#F49000"
+  />
+  <path
+    fill-rule="evenodd"
+    clip-rule="evenodd"
+    d="M84.3163 138.686C84.3163 134.56 87.6742 131.195 91.7903 131.195H103.489C107.605 131.195 110.963 134.56 110.963 138.686C110.963 142.812 107.605 146.177 103.489 146.177H91.7903C87.6742 146.177 84.3163 142.812 84.3163 138.686Z"
+    fill="#F49000"
+  />
+  <path
+    d="M1.66908 110.35L43.8051 33.9174C46.0798 29.9004 51.6041 29.249 54.7453 32.6146C70.0183 49.0084 73.0512 73.8706 62.0027 94.0643C50.9541 114.258 28.3155 124.789 6.32679 120.446C1.7774 119.578 -0.605613 114.475 1.66908 110.35Z"
+    fill="#58CC02"
+  />
+  <path
+    d="M161.331 110.35L119.195 33.9176C116.92 29.792 111.396 29.1406 108.146 32.5062C92.8735 48.9 89.8405 73.7622 100.889 93.9559C111.938 114.15 134.576 124.681 156.565 120.338C161.223 119.578 163.606 114.475 161.331 110.35Z"
+    fill="#58CC02"
+  />
+  <path
+    fill-rule="evenodd"
+    clip-rule="evenodd"
+    d="M50.4125 2.10687C65.5771 8.51241 75.9757 11.7695 81.6083 11.7695C87.2409 11.7695 97.4228 8.62098 112.371 2.21544C122.228 -2.01873 133.71 2.64971 137.934 12.5294C138.909 14.9179 139.451 17.5236 139.451 20.1292V80.819C139.451 112.955 113.454 139.012 81.3916 139.012C49.3293 138.903 23.3328 112.955 23.3328 80.819V20.0207C23.3328 9.27239 31.9983 0.586914 42.8301 0.586914C45.4298 0.586914 47.9211 1.12976 50.4125 2.10687Z"
+    fill="#58CC02"
+  />
+  <path
+    d="M77.059 99.2757C77.2756 98.5157 76.734 97.8643 75.9758 97.8643H61.3528C60.5945 97.8643 60.0529 98.6242 60.2696 99.2757C61.4611 102.641 64.819 105.03 68.6101 105.03C72.4013 105.03 75.8675 102.641 77.059 99.2757ZM101.431 97.8643H86.8077C86.0495 97.8643 85.5079 98.6242 85.7245 99.2757C86.916 102.641 90.2739 105.03 94.065 105.03C97.8562 105.03 101.322 102.641 102.514 99.2757C102.731 98.6242 102.189 97.8643 101.431 97.8643ZM88.6491 110.132H74.0261C73.2678 110.132 72.7262 110.892 72.9429 111.544C74.1344 114.909 77.4923 117.298 81.2834 117.298C85.0746 117.298 88.5408 114.909 89.7323 111.544C90.0572 110.892 89.5157 110.132 88.6491 110.132Z"
+    fill="#89E219"
+  />
+  <path
+    d="M53.7704 11.2264L71.318 30.3345C72.2929 31.3116 71.8596 32.9401 70.6681 33.5915C64.6022 36.3057 57.4532 34.7858 52.9038 29.6831C48.3544 24.5804 47.5962 17.3063 50.8457 11.5522C51.604 10.3579 52.7955 10.2493 53.7704 11.2264Z"
+    fill="#89E219"
+  />
+  <path
+    fill-rule="evenodd"
+    clip-rule="evenodd"
+    d="M68.935 27.946C75.3258 34.4601 86.591 34.4601 93.6317 27.946C100.672 21.4318 92.5485 65.7278 92.5485 65.5106C92.5485 65.5106 88.7573 65.4021 81.175 65.5106C79.117 65.5106 75.4341 65.5106 70.2348 65.5106C65.1438 36.1972 64.7106 23.6032 68.935 27.946Z"
+    fill="#89E219"
+  />
+  <path
+    d="M44.13 15.7862L61.2444 35.0028C62.2192 35.9799 61.786 37.6085 60.5945 38.2599C54.5286 40.9741 47.3796 39.4541 42.8302 34.3514C38.2808 29.2487 37.5226 21.9746 40.8804 16.2205C41.5304 14.9177 43.1551 14.8091 44.13 15.7862Z"
+    fill="#89E219"
+  />
+  <path
+    fill-rule="evenodd"
+    clip-rule="evenodd"
+    d="M52.1456 21.106H52.7955C65.4688 21.106 75.6507 31.42 75.6507 44.0139V56.1736C75.6507 68.8761 65.3604 79.0815 52.7955 79.0815H52.1456C39.4723 79.0815 29.2903 68.7675 29.2903 56.1736V44.1225C29.2903 31.42 39.4723 21.106 52.1456 21.106Z"
+    fill="#89E219"
+  />
+  <path
+    d="M108.796 11.2264L91.5736 30.3345C90.5988 31.3116 91.032 32.9401 92.2235 33.5915C98.2894 36.3057 105.438 34.7858 109.988 29.6831C114.537 24.5804 115.295 17.3063 111.938 11.5522C111.288 10.3579 109.663 10.2493 108.796 11.2264Z"
+    fill="#89E219"
+  />
+  <path
+    d="M118.762 15.7862L101.539 35.0028C100.564 35.9799 100.997 37.6085 102.189 38.2599C108.255 40.9741 115.404 39.4541 119.953 34.3514C124.503 29.2487 125.261 21.9746 121.903 16.2205C121.361 14.9177 119.737 14.8091 118.762 15.7862Z"
+    fill="#89E219"
+  />
+  <path
+    fill-rule="evenodd"
+    clip-rule="evenodd"
+    d="M109.879 21.106H110.529C123.203 21.106 133.385 31.42 133.385 44.0139V56.1736C133.385 68.8761 123.094 79.0815 110.529 79.0815H109.988C97.4228 79.0815 87.2408 68.8761 87.1325 56.2821L87.0242 44.1225C86.9159 31.42 97.0978 21.106 109.879 21.106C109.771 21.106 109.879 21.106 109.879 21.106Z"
+    fill="#89E219"
+  />
+  <path
+    fill-rule="evenodd"
+    clip-rule="evenodd"
+    d="M81.4999 56.2822C85.941 56.2822 89.6238 59.9736 89.6238 64.4249V67.0305C89.6238 71.4818 85.941 75.1731 81.4999 75.1731C77.0588 75.1731 73.376 71.4818 73.376 67.0305V64.4249C73.376 59.9736 77.0588 56.2822 81.4999 56.2822Z"
+    fill="#F49000"
+  />
+  <path
+    d="M70.2347 64.9677C71.2096 59.9736 75.9756 56.2822 81.6082 56.2822C86.9158 56.2822 91.5735 60.0821 92.5484 64.9677V65.402C92.5484 65.7277 92.4401 65.9448 92.1151 65.8362L81.6082 67.6819C81.3916 67.6819 81.3916 67.6819 81.1749 67.6819L70.668 65.8362C70.3431 65.8362 70.2347 65.7277 70.2347 65.402V64.9677Z"
+    fill="#FFC200"
+  />
+  <path
+    d="M83.8829 61.6021C83.6663 61.6021 83.558 61.6021 83.3413 61.4935C81.9332 60.9507 80.6334 60.9507 79.4419 61.4935C78.5753 61.8192 77.7088 61.385 77.3838 60.625C77.0589 59.7564 77.4921 58.8879 78.2504 58.5622C80.2001 57.8022 82.2582 57.8022 84.4245 58.5622C85.2911 58.8879 85.7244 59.7564 85.3994 60.625C85.1828 61.1678 84.5329 61.6021 83.8829 61.6021Z"
+    fill="#FFDE00"
+  />
+  <path
+    fill-rule="evenodd"
+    clip-rule="evenodd"
+    d="M53.337 29.3574C62.1109 29.3574 69.2599 36.5229 69.2599 45.317V54.9796C69.2599 63.7736 62.1109 70.9391 53.337 70.9391C44.5632 70.9391 37.4142 63.7736 37.4142 54.9796V45.317C37.4142 36.5229 44.5632 29.3574 53.337 29.3574Z"
+    fill="white"
+  />
+  <path
+    fill-rule="evenodd"
+    clip-rule="evenodd"
+    d="M53.8286 38.4771C57.9447 38.4771 61.3026 41.8427 61.3026 45.9683V54.2195C61.3026 58.3451 57.9447 61.7107 53.8286 61.7107C49.7125 61.7107 46.3546 58.3451 46.3546 54.2195V45.9683C46.3546 41.8427 49.7125 38.4771 53.8286 38.4771Z"
+    fill="#122431"
+  />
+  <path
+    d="M47.5463 47.8141C50.2384 47.8141 52.4207 45.6268 52.4207 42.9285C52.4207 40.2303 50.2384 38.043 47.5463 38.043C44.8543 38.043 42.672 40.2303 42.672 42.9285C42.672 45.6268 44.8543 47.8141 47.5463 47.8141Z"
+    fill="white"
+  />
+  <path
+    fill-rule="evenodd"
+    clip-rule="evenodd"
+    d="M109.338 29.3574C118.112 29.3574 125.261 36.5229 125.261 45.317V54.9796C125.261 63.7736 118.112 70.9391 109.338 70.9391C100.564 70.9391 93.415 63.7736 93.415 54.9796V45.317C93.415 36.5229 100.564 29.3574 109.338 29.3574Z"
+    fill="white"
+  />
+  <path
+    fill-rule="evenodd"
+    clip-rule="evenodd"
+    d="M108.847 38.4771C112.963 38.4771 116.321 41.8427 116.321 45.9683V54.2195C116.321 58.3451 112.963 61.7107 108.847 61.7107C104.731 61.7107 101.373 58.3451 101.373 54.2195V45.9683C101.373 41.8427 104.731 38.4771 108.847 38.4771Z"
+    fill="#122431"
+  />
+  <path
+    d="M101.698 47.8141C104.39 47.8141 106.572 45.6268 106.572 42.9285C106.572 40.2303 104.39 38.043 101.698 38.043C99.0056 38.043 96.8232 40.2303 96.8232 42.9285C96.8232 45.6268 99.0056 47.8141 101.698 47.8141Z"
+    fill="white"
+  />
+  <path
+    opacity="0.3"
+    fill-rule="evenodd"
+    clip-rule="evenodd"
+    d="M35.6811 146.177H127.969C130.46 146.177 132.518 148.24 132.518 150.737C132.518 153.234 130.46 155.297 127.969 155.297H35.6811C33.1898 155.297 31.1317 153.234 31.1317 150.737C31.1317 148.24 33.1898 146.177 35.6811 146.177Z"
+    fill="#AFAFAF"
+  />
+</svg>
diff --git a/package.json b/package.json
index c25ae2a..6d21db0 100644
--- a/package.json
+++ b/package.json
@@ -1,7 +1,7 @@
 {
   "name": "duolingo",
   "version": "1.1.1",
-  "description": "Script to farm Duolingo XP",
+  "description": "Streak keeper and XP farm for Duolingo",
   "private": true,
   "type": "module",
   "devDependencies": {