From 281552781bb5918e9100db764ce0e9e4e2456e57 Mon Sep 17 00:00:00 2001
From: Connor Fong <dconnorfong@gmail.com>
Date: Wed, 11 Nov 2020 20:07:08 -0800
Subject: [PATCH] Chore: cleaned up package.json, cleaned up README, added
 Stylelint package to disable annoying eeror

---
 README.md    | 33 ++++++++++-----------------------
 package.json |  5 ++++-
 yarn.lock    |  2 +-
 3 files changed, 15 insertions(+), 25 deletions(-)

diff --git a/README.md b/README.md
index 07cec7e..e0db88c 100644
--- a/README.md
+++ b/README.md
@@ -1,6 +1,6 @@
-# club-manager-client
+# Club Manager Client
 
-This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app).
+This repository contains code for the Club Manager application front-end. This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app).
 
 ## Available Scripts
 
@@ -18,14 +18,17 @@ Open [http://localhost:3000](http://localhost:3000) to view it in the browser.
 The page will reload if you make edits.<br />
 You will also see any lint errors in the console.
 
-### `yarn lint`
+### `yarn run lint`
 
 Runs ESLint to ensure that your code is conforming to standards.
 
-### `yarn test`
+### `yarn run lint-style`
 
-Launches the test runner in the interactive watch mode.<br />
-See the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information.
+Runs StyleLint to ensure that Sass/CSS files are conforming to standards.
+
+### `yarn run test`
+
+We don't currently run any automated UI tests due to a rapidly changing interface - they are on the way though! Running this script will execute whatever pre-bundled tests the boilerplate maintainer included.
 
 ### `yarn build`
 
@@ -35,20 +38,4 @@ It correctly bundles React in production mode and optimizes the build for the be
 The build is minified and the filenames include the hashes.<br />
 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
-
-You can learn more in the [Create React App documentation](https://facebook.github.io/create-react-app/docs/getting-started).
-
-To learn React, check out the [React documentation](https://reactjs.org/).
+See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information.
\ No newline at end of file
diff --git a/package.json b/package.json
index 273d518..773f021 100644
--- a/package.json
+++ b/package.json
@@ -1,6 +1,8 @@
 {
-    "name": "boilerplate",
+    "name": "club-manager-client",
     "version": "0.1.0",
+    "description": "React-based client for the Club Manager web application",
+    "homepage": "https://github.com/ubclaunchpad/club-manager-client",
     "private": true,
     "dependencies": {
         "@fortawesome/fontawesome-free": "^5.15.1",
@@ -56,6 +58,7 @@
         "stylelint": "^13.7.2",
         "stylelint-config-prettier": "^8.0.2",
         "stylelint-config-sass-guidelines": "^7.1.0",
+        "stylelint-order": "^4.1.0",
         "stylelint-prettier": "^1.1.2"
     }
 }
diff --git a/yarn.lock b/yarn.lock
index a9d4698..86a623c 100644
--- a/yarn.lock
+++ b/yarn.lock
@@ -11970,7 +11970,7 @@ stylelint-config-sass-guidelines@^7.1.0:
     stylelint-order "^4.0.0"
     stylelint-scss "^3.18.0"
 
-stylelint-order@^4.0.0:
+stylelint-order@^4.0.0, stylelint-order@^4.1.0:
   version "4.1.0"
   resolved "https://registry.yarnpkg.com/stylelint-order/-/stylelint-order-4.1.0.tgz#692d05b7d0c235ac66fcf5ea1d9e5f08a76747f6"
   integrity sha512-sVTikaDvMqg2aJjh4r48jsdfmqLT+nqB1MOsaBnvM3OwLx4S+WXcsxsgk5w18h/OZoxZCxuyXMh61iBHcj9Qiw==