Skip to content

Commit

Permalink
feat(docs): Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
jakedoublev authored Jan 1, 2025
1 parent 07ec865 commit 0c8a084
Showing 1 changed file with 23 additions and 6 deletions.
29 changes: 23 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,14 @@
# this-or-that

## Purpose
<img width="522" alt="Screenshot 2025-01-01 at 3 48 39 PM" src="https://github.com/user-attachments/assets/7408a785-c643-4ea4-a997-dba06b406880" />

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.
Expand All @@ -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.

0 comments on commit 0c8a084

Please sign in to comment.