Skip to content

Commit

Permalink
updates readme
Browse files Browse the repository at this point in the history
  • Loading branch information
msramalho committed Nov 28, 2023
1 parent 197beb1 commit 821084f
Showing 1 changed file with 11 additions and 43 deletions.
54 changes: 11 additions & 43 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,53 +1,21 @@
# default
# Telegram Group Joiner
A web tool to automate joining groups, useful when you're entering a new research topic and have a start point of Telegram groups that are important to monitor. If you have private channel invites, those work too.

## Project setup
https://github.com/bellingcat/telegram-group-joiner

```
# yarn
yarn
![screenshot](https://github.com/bellingcat/telegram-group-joiner/assets/19508417/5e18ab3c-28a7-424f-a297-fb705b3358b2)

# npm
npm install

# pnpm
pnpm install
### Development

# bun
bun install
```

### Compiles and hot-reloads for development
```bash
# install dependencies
yarn

```
# yarn
# run in development mode (hot reload)
yarn dev

# npm
npm run dev
# pnpm
pnpm dev
# bun
bun run dev
```

### Compiles and minifies for production

```
# yarn
# Compiles and minifies for production
yarn build
# npm
npm run build
# pnpm
pnpm build
# bun
bun run build
```

### Customize configuration

See [Configuration Reference](https://vitejs.dev/config/).
The project is auto-deployed to GitHub pages when changes to main are pushed.

0 comments on commit 821084f

Please sign in to comment.