From a844bae4772a2210152230ce8657962057e2f1d4 Mon Sep 17 00:00:00 2001
From: Thiago Chaves <thiago.coh@gmail.com>
Date: Wed, 10 Aug 2022 20:46:08 +0300
Subject: [PATCH] Update README.md with project-relevant content

---
 README.md     | 62 ++++++++++++++++++++++++++++++++++-----------------
 src/index.tsx | 12 ----------
 2 files changed, 42 insertions(+), 32 deletions(-)

diff --git a/README.md b/README.md
index c87e042..35e4b58 100644
--- a/README.md
+++ b/README.md
@@ -1,34 +1,56 @@
-This is a [Next.js](https://nextjs.org/) project bootstrapped with [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packages/create-next-app).
+# Study Card Tool
 
-## Getting Started
+A handy tool for vocabulay study and learning through repetition.
 
-First, run the development server:
+## License
 
-```bash
-npm run dev
-# or
-yarn dev
-```
+GNU Affero General Public License: https://www.gnu.org/licenses/agpl-3.0.en.html
 
-Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
+## Development requirements
 
-You can start editing the page by modifying `pages/index.tsx`. The page auto-updates as you edit the file.
+- node 14 or later: https://nodejs.org/en/
+- yarn 1.22 or later: https://yarnpkg.com/
 
-[API routes](https://nextjs.org/docs/api-routes/introduction) can be accessed on [http://localhost:3000/api/hello](http://localhost:3000/api/hello). This endpoint can be edited in `pages/api/hello.ts`.
+## Running a develpoment environment
 
-The `pages/api` directory is mapped to `/api/*`. Files in this directory are treated as [API routes](https://nextjs.org/docs/api-routes/introduction) instead of React pages.
+1. Clone repository: `git clone https://git.studycardtool.org/tcoh/app.git studycardtool`
+1. Enter local repository folder: `cd studycardtool`
+1. Install dependencies: `yarn`
+1. Run development mode: `yarn start`
 
-## Learn More
+## Deploying your own
 
-To learn more about Next.js, take a look at the following resources:
+1. Go to https://landchad.net/ and follow the "Start a website" tutorial.
+1. Run `yarn build` to generate a build folder
+1. Deploy contents of `build` folder onto `/var/www/yoursite` according to what site you have enabled on nginx
+1. If you have modified the project, make sure you also share a link to your modified repository.
 
-- [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js features and API.
-- [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial.
+## Contributing
 
-You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js/) - your feedback and contributions are welcome!
+Register onto this gitea service either through a local account or a federated account. Bug reports, comments, design ideas and code contributions are welcome.
 
-## Deploy on Vercel
+## Much-needed improvements from most critical to least critical
 
-The easiest way to deploy your Next.js app is to use the [Vercel Platform](https://vercel.com/new?utm_medium=default-template&filter=next.js&utm_source=create-next-app&utm_campaign=create-next-app-readme) from the creators of Next.js.
+- Better PWA lifecycle management
+  - Don't attempt to register right away
+  - Inform user of updates and easy way to reload the updated app
+- Clear usage instructions
+- Better error indication
+- Data model update management
+  - Cleanly handle old data without destroying important user data
+  - Upgrade what can be upgraded, add "old" category labels to cards that may be missing newer information
+- Better parsing of Wiktionary data
+  - Handle declension tables
+  - Handle more word languages
+  - Handle different description languages (can't be done with current method because element IDs change between languages)
+- Configuration of acceptable card sections
+- Data backups as downloadable files, ability to add card packs from a file
 
-Check out our [Next.js deployment documentation](https://nextjs.org/docs/deployment) for more details.
+## Potentially bannable "contributions"
+
+Attempts to merge any of these will be declined and may result in a ban from this repository:
+
+- "Register/login to continue"
+- "Register/login for more functionality"
+- "Analytics"
+- Showing ads or any other forms of in-app "monetization"
diff --git a/src/index.tsx b/src/index.tsx
index dd2cd1f..cfd7784 100644
--- a/src/index.tsx
+++ b/src/index.tsx
@@ -2,8 +2,6 @@ import React from "react";
 import ReactDOM from "react-dom/client";
 import "./index.css";
 import App from "./App";
-import * as serviceWorkerRegistration from "./serviceWorkerRegistration";
-// import reportWebVitals from './reportWebVitals';
 
 const root = ReactDOM.createRoot(
   document.getElementById("root") as HTMLElement
@@ -13,13 +11,3 @@ root.render(
     <App />
   </React.StrictMode>
 );
-
-// If you want your app to work offline and load faster, you can change
-// unregister() to register() below. Note this comes with some pitfalls.
-// Learn more about service workers: https://cra.link/PWA
-serviceWorkerRegistration.register();
-
-// If you want to start measuring performance in your app, pass a function
-// to log results (for example: reportWebVitals(console.log))
-// or send to an analytics endpoint. Learn more: https://bit.ly/CRA-vitals
-// reportWebVitals();