From 417da36e3a611910084854498876b28deecabdce Mon Sep 17 00:00:00 2001
From: osakellarides <73916130+osakellarides@users.noreply.github.com>
Date: Sat, 30 Sep 2023 11:47:18 -0400
Subject: [PATCH 1/2] Update README.md
Added table of Contents, Added 'How To Use' program application description, added 'How To Contribute', added layout of program structure and the tech stack used to create this application.
---
README.md | 151 ++++++++++++++++++++++++++++++++++++++++--------------
1 file changed, 112 insertions(+), 39 deletions(-)
diff --git a/README.md b/README.md
index 7c5d749..6ec2ad6 100644
--- a/README.md
+++ b/README.md
@@ -1,46 +1,119 @@
-Wordally
+
+Table of Contents
+
-09.08.2020 - 13.08.2020 (v1.0)
+Description
+Wordally is a digital solution for those who seek an efficient way to learn foreign language vocabulary for school purposes or to extend their terminology stock. Acquire the habit of studying vocabulary using the Wordally scheme to shorten the time needed to memorize and strengthen memory.
+How To Use
+ Copy this link into your web browser
+
+ - Enter all words and their corresponding translations in the first page (Step 1).
+
- Guess the hidden translations in the right column. Press the magnifying glass to view the answer (Step 2).
+ - Guess the hidden word in the left column. Press the magnifying glass to view the answer (Step 3).
+ - Type out the word for the corresponding translation (Step 4).
+ - Verify your results and receive your score (Step 5).
+ - Copy the URL using the buttom on the bottom right to test your skills again!
+
+It's that simple. By repeating this method at least 3 times (with breaks between each try), it's possible to learn terminology in 30 minutes.
-Description
+How To Contribute
+
+ - Make sure you have installed Node.js
+ - Fork the repository
+ - Clone the repository
git clone https://github.com/trolit/Wordally.git
+ - Create your feature branch
git checkout -b my-new-feature
+ - Test and commit your changes
git commit -am 'added feature
+ - Push to branch
git push origin my-new-feature
+ - Create a Pull Request
+
-Wordally is digital solution for those who seek efficient way to learn foreign language vocabulary for school purposes or to extend terminology stock. Acquire habit to study vocabulary like in Wordally scheme to shorten the time needed to memorize and strengthen memory. Implemented idea comes from author's private experience from learning english words.
-
-> Method relies on 3 steps. In first two, cover one column and try to guess hidden words by looking at visible column, then swap(do the same for opposite column). If you don't know something, don't worry just repeat that step few times. It's also worth to not guess words in the same order. In last step, write translations on sheet of paper(again, don't always write them in the same order) and then try to write all words. It's that simple. By doing that method at least 3 times(with breaks between each try) it's possible to learn terminology in 30 minutes(motivation also matters) :)
+Project Directory Structure
+ Here is a simplified project structure so that you can understand what goes into the creation of this project.
+
+assets/
+ ├── css/
+ │ ├── blk-design-system.css
+ │ ├── blk-design-system.css.map
+ │ ├── blk-design-system.min.css
+ │ ├── nucleo-icons.css
+ │ ├── PlaylistRow.tsx
+ │ ├── PlaylistSearch.tsx
+ │ └── PlaylistTable.tsx
+ ├── js/
+ │ ├── core/
+ │ ├── plugins/
+ │ ├── blk-design-system.js
+ │ ├── blk-design-system.js.map
+ │ ├── blk-design-system.min.js
+ │ ├── wordally_Misc.js
+ │ └── wordally_Renderer.js
+ ├── scss/
+ │ ├── blk-design-system.scss
+ │ └── blk-design-system/
+ │ └── bootstrap/
+ │ ├── mixins/
+ │ └── utilities/
+ │ └── custom/
+ │ ├── cards/
+ │ ├── mixins/
+ │ ├── sections/
+ │ ├── utilities/
+ │ └── vendors/
+ ├── fonts/
+ ├── img/
+ └── sounds/
+
-Notes
+Notes
+
+ - The link includes parameters in the URL so you won't have to write words and translations manually--they will be added automatically.
+ - Primarily, I wanted to make users only type words while translations would be served by Marak's translate.js library, but I didn't notice that it's an old solution and Google API used there was deprecated. Now, when Google API is limited to "quota cost," I've decided that Wordally will require writing those translations manually. However, after finishing all steps, you can generate a URL for your word/translation template, and when you use that generated URL, JavaScript will fill those inputs for you!
+ - Test it on your phone!
+ - Add at the end of the generated URL ```&onlytest=true``` param to force Wordally to redirect to the tab with a verification sequence and hide the back button. (example)
+
-- If you want to check Wordally, click on this link (it includes parameters in URL so you won't have to write words and translations manually, they will be added automatically)
-- Primarily I wanted to make user only type words while translations would be served by Marak's translate.js library but didn't notice that it's old solution and Google API used there was depracated. Now when Google API is limited to "quota cost", I've decided that Wordally will require to write those translations manually. However, after finishing all steps you can generate URL for your word/translation template and when you use that generated URL JavaScript will will those inputs for you!
-- Test it on phone:P
-- Add at the end of generated URL ```&onlytest=true``` param to force Wordally to redirect to tab with verification sequence and hide back button. (example)
+Screenshots
+
-Screenshots
+Tech Stack
+ This application was built using the following tools/libraries.
+
+ - React - JavaScript library for building user interfaces
+ - Bootstrap 4 - Styling and UI components
+ - Clipboard.js - Copying clipboard functionality
+
+ Refer below to the list of references to learn more about these resources.
+References
+
-| | |
-| :---: | :---: |
-| 
| 
|
-| 
| 
|
-
-
-References
-
-- BLK Design System (Bootstrap 4 Kit)
-- gulp.js
-- Node.js v12.16.2
-- Wordally logo
-- clipboard.js
-- Font Awesome Animation
-- Iconify icons
-- Nucleo icons(shared by Creative Tim)
-- Error sound(licensed under CC BY-NC 4.0)
-
-License
-
-Wordally is licensed under MIT and is open source :]
-
-
-
-
-Template generated using EzGitDoc
+License
+Wordally is licensed under MIT and is open source :]
+Template generated using EzGitDoc
From 40f9b489fe88bac29e8e1891f0d27d36691d1639 Mon Sep 17 00:00:00 2001
From: osakellarides <73916130+osakellarides@users.noreply.github.com>
Date: Sat, 30 Sep 2023 11:50:24 -0400
Subject: [PATCH 2/2] Update README.md
Added 'Tech Stack' to table of contents
---
README.md | 3 ++-
1 file changed, 2 insertions(+), 1 deletion(-)
diff --git a/README.md b/README.md
index 6ec2ad6..2b446d8 100644
--- a/README.md
+++ b/README.md
@@ -7,6 +7,7 @@
Project Directory Structure
Notes
Screenshots
+ Tech Stack
References
License
@@ -93,7 +94,7 @@ assets/
-Tech Stack
+Tech Stack
This application was built using the following tools/libraries.
- React - JavaScript library for building user interfaces