From 23332966d75819eb056e1bc83dd41d1de8775e3f Mon Sep 17 00:00:00 2001 From: Xinos <40886699+userXinos@users.noreply.github.com> Date: Sat, 3 Feb 2024 16:51:51 +0700 Subject: [PATCH] Update README.md [skip ci] --- README.md | 36 ++++++++++++++++-------------------- 1 file changed, 16 insertions(+), 20 deletions(-) diff --git a/README.md b/README.md index 3a6ffae8..885ce6fd 100644 --- a/README.md +++ b/README.md @@ -1,34 +1,30 @@ -# HadesSpace -Parsing and displaying game data +

logo

+

HadesSpace

-### Build +The project contains a tool for parsing csv tables compiled from game data. The developed parser combines information from various game tables, collecting data in a convenient format (.js, .json etc). Parsed data is also used by community members to develop their Discord bots. -```bash -# install dependencies -npm install +The Vuejs3 web application supports PWA and optimal display on various screens, and also supports the entire locale from the game and additional ones contributed by the community. [Current deployment](https://userxinos.github.io/HadesSpace/) -# build -npm run build -``` +If you are a data miner, you can find tables in the [parser directory](/parser), and images in [src](src/img) -### Build a developer build +### Build web-app ```bash -# install dependencies if not already installed -npm install - -# parse game data -npm run parser +npm install # install dependencies +npm run build # build +``` -# generate localization strings -npm run i18n:full +### Build a developer build -# deploy local server -npm run dev +```bash +npm install # install dependencies if not already installed +npm run parser # parse game data +npm run i18n:full # generate localization strings +npm run dev # deploy local server ``` ### Requirements -- Latest LTS version of [NodeJS](https://nodejs.org) +- 17 version of [NodeJS](https://nodejs.org) ### Modules