From 5842dfdf8c6dbe80211190f47939051f8acab1f6 Mon Sep 17 00:00:00 2001 From: Esteban Abaroa Date: Mon, 24 Apr 2023 17:20:14 +0000 Subject: [PATCH] add readme --- README.md | 20 +++++++++++++++++++- 1 file changed, 19 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index da4b6b27..a3f1d2dd 100644 --- a/README.md +++ b/README.md @@ -1 +1,19 @@ -# plebchan \ No newline at end of file +_Telegram group for this repo https://t.me/plebchanreact_ + +_Demo https://plebchan.vercel.app and https://plebchan.eth.limo_ + +### Development: + +For development it is recommened to use the [mock content env variables](https://github.com/plebbit/plebbit-react-hooks/blob/master/docs/mock-content.md#add-env-variable-for-mocking) because the demo subplebbits are slow and often offline. + +### Scripts: + +- Web client: `yarn start` +- Electron client (must start web client first): `yarn electron` +- Electron client and don't delete data: `yarn electron:no-delete-data` +- Web client and electron client: `yarn electron:start` +- Web client and electron client and don't delete data: `yarn electron:start:no-delete-data` + +### Build: + +The linux/windows/mac/android build scripts are in https://github.com/plebbit/plebchan/blob/master/.github/workflows/release.yml