diff --git a/README.md b/README.md index 44485e9..824b098 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,6 @@ A web-based esoteric correspondence app for tarot, astrology, calendars, symbols [![Node.js](https://img.shields.io/badge/Node.js-18%2B-5FA04E?logo=node.js&logoColor=white)](https://nodejs.org/) [![Git](https://img.shields.io/badge/VCS-Git-F05032?logo=git&logoColor=white)](https://git-scm.com/) -[![Deck Repository](https://img.shields.io/badge/Decks-tarot--deck-1D4ED8)](https://code.glowers.club/goyimnose/tarot-deck) ## Features @@ -17,12 +16,12 @@ A web-based esoteric correspondence app for tarot, astrology, calendars, symbols 1. Install Node.js: https://nodejs.org/en/download 2. Start the API and confirm its base URL and API key. -3. Clone this repository. +3. Clone or download this repository. 4. Install dependencies. 5. Start the client. ```powershell -git clone https://code.glowers.club/goyimnose/taroTime.git +git clone Set-Location .\TaroTime npm install npm run start @@ -30,25 +29,16 @@ npm run start The app opens in your browser (typically at `http://127.0.0.1:8080`) and stays in shell mode until you enter a reachable API base URL and a valid API key. -For local development with the current API configuration: +For local development with a default local API configuration: ```powershell API Base URL: http://localhost:3100 -API Key: aaa +API Key: ``` -The current API also accepts `bbb` as a valid key. - - - ## NPM Scripts | Command | Description | | --- | --- | | `npm run start` | Serve the static client locally and open `index.html`. | | `npm run dev` | Alias of `npm run start`. | - -## Project Links - -- Main app: https://code.glowers.club/goyimnose/tarotime -- Deck repo: https://code.glowers.club/goyimnose/tarot-deck