From 5ce5ca2637838328749373df27c1b360f59eb8c3 Mon Sep 17 00:00:00 2001
From: oliverhnat <oliver.hnat@gmail.com>
Date: Tue, 9 Apr 2024 12:39:56 +0200
Subject: [PATCH] Add README.md

---
 README.md | 100 ++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 100 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..e67834e
--- /dev/null
+++ b/README.md
@@ -0,0 +1,100 @@
+# WordAX - study helper
+
+[![Contributors][contributors-shield]][contributors-url]
+[![Forks][forks-shield]][forks-url]
+[![Stargazers][stars-shield]][stars-url]
+[![Issues][issues-shield]][issues-url]
+[![LinkedIn][linkedin-shield]][linkedin-url]
+
+<h3 align="center">WordAX</h3>
+
+  <p align="center">
+    The Smart Way to Master Anything with Flashcards
+    <br />
+    <br />
+    <a href="https://github.com/olinpin/WordAX/issues/new?labels=bug&template=bug-report---.md">Report Bug</a>
+    ·
+    <a href="https://github.com/olinpin/WordAX/issues/new?labels=enhancement&template=feature-request---.md">Request Feature</a>
+  </p>
+</div>
+
+
+<!-- TABLE OF CONTENTS -->
+<details>
+  <summary>Table of Contents</summary>
+  <ol>
+    <li>
+      <a href="#about-the-project">About The Project</a>
+      <ul>
+        <li><a href="#built-with">Built With</a></li>
+      </ul>
+    </li>
+    <li><a href="#roadmap">Roadmap</a></li>
+    <li><a href="#contact">Contact</a></li>
+  </ol>
+</details>
+
+## About The Project
+Hey! Welcome to WordAX—your next favorite flashcard app that's all about boosting your learning game without emptying your wallet. We're here to spice things up in the flashcard world, offering a sleek, easy-to-navigate platform brimming with features to supercharge your memorization skills. Dive into an ocean of decks on anything and everything, with smart algorithms that keep your study sessions fresh and focused. And keep your eyes peeled for our upcoming feature: an easy deck download experience, reminiscent of an Anki store, but with our unique WordAX twist.
+
+### Why
+Why settle for pricey apps when you can have WordAX? We're here to prove that effective learning tools don't need to cost a fortune. Inspired by the best, without the heavy price tag, WordAX is your go-to for learning anything, anywhere, any time. Ready to level up your learning? WordAX has got your back.
+
+
+
+<p align="right">(<a href="#readme-top">back to top</a>)</p>
+
+
+### Built With
+* [![Swift][Swift]][Swift-url]
+* [![iOS][iOS]][iOS-url]
+* [![Xcode][Xcode]][Xcode-url]
+* [![NeoVim][NeoVim]][NeoVim-url]
+
+<p align="right">(<a href="#readme-top">back to top</a>)</p>
+
+
+## Roadmap
+- [ ] Anki card "store" - download any anki flashcards you want from the online store that already exists somewhere
+- [ ] Import anki cards in the .anki format
+- [x] Create flashcards
+- [ ] Add tags to cards
+- [ ] Specify how often you want each card to be seen (per folder/tag?)
+- [ ] Add tags/folders
+- [x] Store cards persistently
+	- [x] For start store them on the phone - stored using Core Data
+	- [ ] Maybe later add a storage in cloud, so that you can sync with other devices if the app is multi-platform?
+- [ ] Add some animations?
+- [ ] Implement logic
+- [ ] Export your anki to the store?
+
+<p align="right">(<a href="#readme-top">back to top</a>)</p>
+
+
+## Contact
+
+Oliver Hnat - [@oliverhnat](https://twitter.com/oliverhnat) - oliver@hnat.me
+
+Project Link: [https://github.com/olinpin/WordAX](https://github.com/olinpin/WordAX)
+
+<p align="right">(<a href="#readme-top">back to top</a>)</p>
+
+<!-- MARKDOWN LINKS -->
+[contributors-shield]: https://img.shields.io/github/contributors/olinpin/WordAX.svg?style=for-the-badge
+[contributors-url]: https://github.com/olinpin/WordAX/graphs/contributors
+[forks-shield]: https://img.shields.io/github/forks/olinpin/WordAX.svg?style=for-the-badge
+[forks-url]: https://github.com/olinpin/WordAX/network/members
+[stars-shield]: https://img.shields.io/github/stars/olinpin/WordAX.svg?style=for-the-badge
+[stars-url]: https://github.com/olinpin/WordAX/stargazers
+[issues-shield]: https://img.shields.io/github/issues/olinpin/WordAX.svg?style=for-the-badge
+[issues-url]: https://github.com/olinpin/WordAX/issues
+[linkedin-shield]: https://img.shields.io/badge/-LinkedIn-black.svg?style=for-the-badge&logo=linkedin&colorB=555
+[linkedin-url]: https://linkedin.com/in/oliver-hnat-71ab9a1b3/
+[Swift]: https://img.shields.io/badge/swift-F54A2A?style=for-the-badge&logo=swift&logoColor=white
+[Swift-url]: https://www.swift.org/
+[iOS]: https://img.shields.io/badge/iOS-000000?style=for-the-badge&logo=ios&logoColor=white
+[iOS-url]: https://www.apple.com/ios
+[xCode]: https://img.shields.io/badge/Xcode-007ACC?style=for-the-badge&logo=Xcode&logoColor=white
+[xCode-url]: https://developer.apple.com/xcode/
+[NeoVim]: https://img.shields.io/badge/NeoVim-%2357A143.svg?&style=for-the-badge&logo=neovim&logoColor=white
+[NeoVim-url]: https://neovim.io/