From 47bff7b927f10b540aa6baa5a60dfa8e9cc735c6 Mon Sep 17 00:00:00 2001 From: Araozu Date: Fri, 3 May 2024 07:02:30 -0500 Subject: [PATCH] Modify readme --- README.md | 38 ++++++++------------------------------ 1 file changed, 8 insertions(+), 30 deletions(-) diff --git a/README.md b/README.md index 6a17645..84edfc4 100644 --- a/README.md +++ b/README.md @@ -1,34 +1,12 @@ -## Usage +# Card-jong (frontend) -Those templates dependencies are maintained via [pnpm](https://pnpm.io) via `pnpm up -Lri`. +Card-jong is a Mahjong-like game, but uses +2 decks of cards instead of tiles. -This is the reason you see a `pnpm-lock.yaml`. That being said, any package manager will work. This file can be safely be removed once you clone a template. +Has a SolidJS frontend and will connect to a +Go backend, which will have all the game logic +and state. -```bash -$ npm install # or pnpm install or yarn install -``` +This frontend will only render the state received +from the backend. -### Learn more on the [Solid Website](https://solidjs.com) and come chat with us on our [Discord](https://discord.com/invite/solidjs) - -## Available Scripts - -In the project directory, you can run: - -### `npm run dev` or `npm start` - -Runs the app in the development mode.
-Open [http://localhost:3000](http://localhost:3000) to view it in the browser. - -The page will reload if you make edits.
- -### `npm run build` - -Builds the app for production to the `dist` folder.
-It correctly bundles Solid in production mode and optimizes the build for the best performance. - -The build is minified and the filenames include the hashes.
-Your app is ready to be deployed! - -## Deployment - -You can deploy the `dist` folder to any static host provider (netlify, surge, now, etc.)