Skip to content

docs: update outdated README info #774

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
wyne merged 2 commits into from
Oct 24, 2026
Merged

docs: update outdated README info #774

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a496654
docs: rewrite README for the current codebase
claude Oct 24, 2026
3a9d55e
docs: simplify README and replace demo video with screenshot
claude Oct 24, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ This file provides guidance to AI coding agents when working with code in this r

## Project Overview

ScorePad with Rounds is a React Native app built with Expo SDK 56 for tracking game scores with round-by-round history. The app is cross-platform (iOS, Android, Web) and uses TypeScript throughout.
ScorePad with Rounds is a React Native app built with Expo SDK 57 for tracking game scores with round-by-round history. The app is cross-platform (iOS, Android, Web) and uses TypeScript throughout.

## Development Commands

Expand Down
6 changes: 3 additions & 3 deletions Contributing.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
| Tool | Version | Notes |
|------|---------|-------|
| nvm | latest | Node version manager |
| Node.js | 20.18 (via `.nvmrc`) | Installed via `nvm` |
| Node.js | 20.19.4 (via `.nvmrc`) | Installed via `nvm` |
| npm | (bundled with Node) | Used for all JS dependencies |
| EAS CLI | latest | Required for building and submitting |
| JDK | 17 | Android builds only |
Expand All @@ -19,7 +19,7 @@
# Install nvm — https://github.com/nvm-sh/nvm
curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.40.1/install.sh | bash

# From the project root — installs and activates the version in .nvmrc (20.18)
# From the project root — installs and activates the version in .nvmrc (20.19.4)
nvm install
nvm use
```
Expand All @@ -30,7 +30,7 @@ nvm use
npm install
```

> `--legacy-peer-deps` is required because some packages (e.g. `@reduxjs/toolkit`) have not yet declared React 19 peer dependency support, though they are compatible.
> `.npmrc` sets `legacy-peer-deps=true`, so a plain `npm install` works. It is needed because some packages (e.g. `@reduxjs/toolkit`) have not yet declared React 19 peer dependency support, though they are compatible.

### Install EAS CLI

Expand Down
9 changes: 3 additions & 6 deletions Readme.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,15 +3,12 @@

An open-source, multi-platform score keeping app with per-round score history.

<img src="assets-stores/apple/iOS%20Phones%20-%206.7%20(Island)/01.png" height="500" alt="ScorePad game board">

## Download

- [Apple App Store (iPhone, iPad, and M1 Mac)](https://apps.apple.com/us/app/scorepad-with-rounds/id1577906063)
- [Apple App Store (iPhone, iPad, and Mac)](https://apps.apple.com/us/app/scorepad-with-rounds/id1577906063)
- [Google Play Store (Android phones and tablets)](https://play.google.com/store/apps/details?id=com.wyne.scorepad)
- [Web App](https://wyne.github.io/scorepad-app/)

## Demo

https://github.com/wyne/scorepad-react-native/assets/1986068/05bde405-3025-4156-8c52-477d4b1f5912

## Website

Expand Down
Loading