From 3b3529d98b15e67822e4d3f1fb448d36df5771db Mon Sep 17 00:00:00 2001
From: Nicholas Sorokin <nicholas.sorokin@hotmail.com>
Date: Sun, 7 Jul 2024 15:03:56 +0930
Subject: [PATCH] docs: update the readme

---
 README.md    | 30 ++++++++++++++----------------
 package.json |  4 ++--
 2 files changed, 16 insertions(+), 18 deletions(-)

diff --git a/README.md b/README.md
index b58e0af..f7026e7 100644
--- a/README.md
+++ b/README.md
@@ -1,12 +1,20 @@
-# Getting Started with Create React App
+# Pandemic Legacy City Tracker
+
+During a game of Pandemic Legacy, players are required to draw "City" cards from an "Infection" deck to determine the location of outbreaks and other events.
+
+This app helps to keep track of what cards are on the the Infection deck, and how likely each card is to be drawn next.
+
+You may access the app [https://oldstarchy.github.io/pandemic_tracker/](https://oldstarchy.github.io/pandemic_tracker/).
+
+## Contributing
 
 This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app).
 
-## Available Scripts
+### Available Scripts
 
 In the project directory, you can run:
 
-### `yarn start`
+#### `yarn start`
 
 Runs the app in the development mode.\
 Open [http://localhost:3000](http://localhost:3000) to view it in the browser.
@@ -14,12 +22,12 @@ Open [http://localhost:3000](http://localhost:3000) to view it in the browser.
 The page will reload if you make edits.\
 You will also see any lint errors in the console.
 
-### `yarn test`
+#### `yarn test`
 
 Launches the test runner in the interactive watch mode.\
 See the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information.
 
-### `yarn build`
+#### `yarn build`
 
 Builds the app for production to the `build` folder.\
 It correctly bundles React in production mode and optimizes the build for the best performance.
@@ -29,17 +37,7 @@ Your app is ready to be deployed!
 
 See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information.
 
-### `yarn eject`
-
-**Note: this is a one-way operation. Once you `eject`, you can’t go back!**
-
-If you aren’t satisfied with the build tool and configuration choices, you can `eject` at any time. This command will remove the single build dependency from your project.
-
-Instead, it will copy all the configuration files and the transitive dependencies (webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except `eject` will still work, but they will point to the copied scripts so you can tweak them. At this point you’re on your own.
-
-You don’t have to ever use `eject`. The curated feature set is suitable for small and middle deployments, and you shouldn’t feel obligated to use this feature. However we understand that this tool wouldn’t be useful if you couldn’t customize it when you are ready for it.
-
-## Learn More
+### Learn More
 
 You can learn more in the [Create React App documentation](https://facebook.github.io/create-react-app/docs/getting-started).
 
diff --git a/package.json b/package.json
index 2f90bc7..44d5243 100644
--- a/package.json
+++ b/package.json
@@ -4,9 +4,9 @@
   "private": true,
   "repository": {
     "type": "git",
-    "url": "https://github.com/OldStarchy/pandemic_tracker.git"
+    "url": "https://github.com/oldstarchy/pandemic_tracker.git"
   },
-  "homepage": "https://OldStarchy.github.io/pandemic_tracker",
+  "homepage": "https://oldstarchy.github.io/pandemic_tracker/",
   "dependencies": {
     "@fortawesome/fontawesome-svg-core": "^6.5.2",
     "@fortawesome/free-brands-svg-icons": "^6.5.2",