readme and ci

.gitlab-ci.yml

@@ -33,3 +33,19 @@ upload_to_minio:
     - aws s3 --endpoint=https://minio.mycard.moe:9000 sync --delete output/ s3://mycard/cn-database
   only:
     - master
+
+deploy_to_ygopro_server:
+  stage: deploy
+  dependencies: []
+  tags:
+    - linux
+  script:
+    - apt update && apt -y install openssh-client rsync coreutils
+    - mkdir ~/.ssh
+    - chmod 700 ~/.ssh
+    - ssh-keyscan koishi.momobako.com >> ~/.ssh/known_hosts
+    - echo $NANAHIRA_SSH_KEY | base64 --decode > ~/.ssh/id_rsa
+    - chmod 600 ~/.ssh/*
+    - scp -r output/cards.cdb nanahira@koishi.momobako.com:~/ygopro-cn/cards.cdb
+  only:
+    - master

README.md

 # ygopro-cn-database-generator
 
-Generates CN env database from NW posts.
\ No newline at end of file
+[![pipeline status](https://code.mycard.moe/mycard/ygopro-cn-database-generator/badges/master/pipeline.svg)](https://code.mycard.moe/mycard/ygopro-cn-database-generator/-/commits/master)
+
+Generates CN env database from NWBBS posts.
+
+## How to use
+
+1. `npm ci && npm run build`
+
+2. `git clone https://code.mycard.moe/mycard/ygopro-database ygopro-database`
+
+3. `npm run start`
+
+4.  Pick the output database from `output/cards.cdb` .
+
+## Configurations
+
+By default, configurations are not needed for default settings. Configurations are done by env vars as follows.
+
+* `POST_DEPTH` How many pages it would read in the homepage of NWBBS.
+
+* `CN_DATABASE_PATH` `JP_DATABASE_PATH` Japanese and Chinese database path.
+
+* `OUTPUT_PATH` Output path.