From 0c8a084cffaecbacfde60e546a15c95e5697b345 Mon Sep 17 00:00:00 2001 From: Jake Van Vorhis <83739412+jakedoublev@users.noreply.github.com> Date: Wed, 1 Jan 2025 15:54:46 -0800 Subject: [PATCH] feat(docs): Update README.md --- README.md | 29 +++++++++++++++++++++++------ 1 file changed, 23 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index c0fec42..3c7df15 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,14 @@ # this-or-that -## Purpose +Screenshot 2025-01-01 at 3 48 39 PM + +Available at https://jakedoublev.github.io/this-or-that/ + +## Overview It is hard to rank a list of priorities against each other. -`this-or-that` makes it easier by taking in a list of options and simply asking +The `this-or-that` app makes it easier by taking in a list of options and simply asking "this or that" until the stack ranking is complete. One tradeoff at a time, over and over, until the order is clear. @@ -13,7 +17,20 @@ Data never leaves your browser and does not save between refreshes, so your deci ## Tech Stack -1. React -2. TypeScript -3. Vite -4. GitHub Pages deployment via GitHub Action +1. [React](https://react.dev/reference/react) +2. [TypeScript](https://www.typescriptlang.org/) +3. [Vite](https://vite.dev/guide/) +4. [GitHub Pages](https://pages.github.com/) deployment via [GitHub Action](https://docs.github.com/en/actions/about-github-actions/understanding-github-actions) + +## Contributing + +1. **Switch to the correct [Node.js version](https://nodejs.org/docs/latest/api/):** + - Run `nvm use` ([nvm documentation](https://github.com/nvm-sh/nvm)). + - Alternatively, check the `.nvmrc` file for the required version. + +2. **Install dependencies:** + - Run `npm ci` to perform a clean installation of all dependencies. + +3. **Start the project:** + - Use `npm run dev` to start the project in development mode. + - Or, use `npm run build` to create a production-ready build.